https://github.com/quanhieu/operor-turbo
https://github.com/quanhieu/operor-turbo
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/quanhieu/operor-turbo
- Owner: quanhieu
- Created: 2024-05-24T15:02:52.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-06-15T21:23:35.000Z (11 months ago)
- Last Synced: 2025-01-09T08:22:59.244Z (4 months ago)
- Language: TypeScript
- Homepage: https://operor-turbo-nest.vercel.app
- Size: 800 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NestJS / Next.js Turborepo starter
This is an unofficial starter Turborepo.
## What's inside?
This Turborepo includes the following packages/apps:
### Apps and Packages
- `api`: a [NestJS](https://nestjs.com/) app
- `web`: another [Next.js](https://nextjs.org/) app
- `ui`: a stub React component library shared by both `web` and `docs` applications
- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `tsconfig`: `tsconfig.json`s used throughout the monorepo
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
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting
### Installation
```
pnpm install
```
_Hint: If you'd like to clone the repository without the git history, you can use [degit](https://github.com/Rich-Harris/degit)._
### Build
To build all apps and packages, run the following command:
```
pnpm build
```
### Develop
To develop all apps and packages, run the following command:
```
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:
```
npx nestjs-turbo
```
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)
Learn more about NestJS & Next.js:
- [NestJS Documentation](https://docs.nestjs.com/)
- [Next.js Documentation](https://nextjs.org/docs)