Turborepo nuxt starter
This is a monorepo with Nuxt, Histoire, Vitest & VitePress as a starter for any project that can be easily extended. You can also find additional branches:
What's inside?
This turborepo uses pnpm as a package manager. It includes the following packages/apps:
Apps and Packages
web
: a Nuxt.js appdocs
: a VitePress appui
: a stub Nuxt component library with Histoireconfig
:eslint
configuration (using @antfu/eslint-config)tsconfig
:tsconfig.json
s used throughout the monorepo
Each package/app is 100% TypeScript.
Utilities
This turborepo has some additional tools already setup for you:
- TypeScript for static type checking
- ESLint for code linting
Setup
To install all dependencies, run the following command:
pnpm install
Develop
To develop all apps and packages, run the following command:
pnpm run dev
Lint
To check & fix linter through all apps and packages, run the following command:
pnpm run lint
pnpm run lint:fix
Test
To run tests through all apps and packages, run the following command:
pnpm run test
Build
To build all apps and packages, run the following command:
pnpm run build
Remote Caching
Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:
pnpm dlx turbo login
This will authenticate the Turborepo CLI with your Vercel account.
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:
pnpm dlx turbo link
Use a custom remote cache server turbo-remote-cache
Useful Links
Learn more about the power of Turborepo: