Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dangvanthanh/nuxt-turborepo-boilerplate
Starter template or boilerplate using Nuxt, Turborepo and Vite
https://github.com/dangvanthanh/nuxt-turborepo-boilerplate
biomejs bun monorepo nuxt shadcn-ui turborepo
Last synced: about 2 months ago
JSON representation
Starter template or boilerplate using Nuxt, Turborepo and Vite
- Host: GitHub
- URL: https://github.com/dangvanthanh/nuxt-turborepo-boilerplate
- Owner: dangvanthanh
- Created: 2024-03-19T14:22:04.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-23T14:34:08.000Z (3 months ago)
- Last Synced: 2024-10-12T19:27:15.245Z (2 months ago)
- Topics: biomejs, bun, monorepo, nuxt, shadcn-ui, turborepo
- Language: Vue
- Homepage: https://nuxt-turborepo-boilerplate.vercel.app
- Size: 2.42 MB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nuxt Turborepo Boilerplate
> Starter template or boilerplate using Nuxt, Turborepo and Vite
## What's inside?
This turborepo uses [bun](https://bun.sh/) as a package manager. It includes the following packages/apps:
### Apps, Layers and Packages
- `web`: Nuxt app
- `emails`: Nuxt layer for shared emails
- `ui`: Nuxt layer for shared ui
- `utils`: Nuxt layer for shared composables, utils functions
- `biome-config`: Biome config for the repo
- `typescript-config`: TypeScript config for the repo
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
### Utilities
This Turborepo has some additional tools already setup for you:
- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [Biome](https://biomejs.dev/) for code linting and formatting
- [Shadcn-vue](https://www.shadcn-vue.com) - Beautifully designed components
- [Vue Email](https://vuemail.net/) for generation of writing emails
- [tRPC Nuxt](https://trpc-nuxt.vercel.app/) for end-to-end typesafe APIs in Nuxt applications.
### Build
To build all apps and packages, run the following command:
```
cd nuxt-turborepo-boilerplate
bun build
```
### Develop
To develop all apps and packages, run the following command:
```
cd nuxt-turborepo-boilerplate
bun dev
```
### Remote Caching
Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/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](https://vercel.com/signup), then enter the following commands:
```
cd my-turborepo
npx turbo login
```
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
```
npx turbo link
```
## Useful Links
Learn more about the power of Turborepo:
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
## License
MIT © [Dang Van Thanh](https://dangthanh.org)