This monorepo hosts the VIntl for Nuxt module as well as other projects that help building it.
Legend: 🔒 Private · 🌐 Website
- Playground 🔒
- Docs 🔒 🌐
If you want to contribute a change or just want to try some changes in the project, follow the instruction below to get started.
Note Corepack is recommended! It allows you to quickly switch package managers and their versions. As this monorepo uses pnpm, it is specified in root
package.json, so you can usecorepack prepare --activateto quickly switch to the version recommended for this repository. See corepack docs for details.
Clone the repository
git clone https://github.com/vintl-dev/nuxt.git vintl-nuxt cd vintl-nuxtInstall dependencies
pnpm install
Prepare apps (optional)
This will build the module and prepare all the apps, such as sandbox and docs.
pnpm all:prepareBuild module
pnpm mod:build
Start playground
Running playground in dev mode you can play and test that the module works in a regular Nuxt project.
pnpm pg:dev
Create a changeset
If you want to make a contribution to the module, make a changeset. This will ask you about the level of change (patch, minor or major) and the description of the change made.
You don't need changesets for private packages (like playground).
pnpm changeset
Warning Do not run commands like
pnpm addwhen your working directory is not set to the monorepo root.pnpmseems to ignore top-level.npmrcand will reinstall dependency tree in a manner currently incompatible with Nuxt. Usepnpm --filter <pkg/relative-path> addfrom the root. A lot of convenient scripts utilising Turborepo are also available in monorepo'spackage.json. You rarely need tocdinto subdirectories.