Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vndevteam/nestjs-turbo
Monorepo with NestJS boilerplate, Next.js, Nextra docs & Turbo
https://github.com/vndevteam/nestjs-turbo
nestjs nextjs nextra turborepo typeorm
Last synced: about 2 months ago
JSON representation
Monorepo with NestJS boilerplate, Next.js, Nextra docs & Turbo
- Host: GitHub
- URL: https://github.com/vndevteam/nestjs-turbo
- Owner: vndevteam
- License: mit
- Created: 2024-09-20T09:21:17.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-18T00:42:01.000Z (about 2 months ago)
- Last Synced: 2024-11-18T01:31:47.781Z (about 2 months ago)
- Topics: nestjs, nextjs, nextra, turborepo, typeorm
- Language: TypeScript
- Homepage:
- Size: 441 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NestJS Turborepo starter
A monorepo boilerplate built with [Turborepo](https://turbo.build/repo) and [NestJS](https://nestjs.com/).
## Getting started
```sh
# Clone the repository
git clone https://github.com/vndevteam/nestjs-turbo.git
# Create environment variables file.
cp apps/admin-api/.env.example apps/admin-api/.env
cp apps/user-api/.env.example apps/user-api/.env
# Install dependences.
pnpm install
```
## Checklist
When you use this template, try follow the checklist to update your info properly
- [ ] Change the author name in `LICENSE`
- [ ] Change configurations in `.env`
- [ ] Remove the `.github` folder which contains the funding info
- [ ] Clean up the README.md file
## What's inside?
This project includes the following packages/apps:
### Apps and Packages
- `docs`: a [Next.js](https://nextjs.org/) app
- `web`: another [Next.js](https://nextjs.org/) app
- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
### Utilities
This project has some additional tools already setup for you:
- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting
### Build
To build all apps and packages, run the following command:
```sh
cd my-turborepo
pnpm build
```
### Develop
To develop all apps and packages, run the following command:
```sh
cd my-turborepo
pnpm 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:
```sh
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:
```sh
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)
## Support
[Discuss on Github](https://github.com/vndevteam/nestjs-turbo/discussions)