-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e4802ff
commit 068744c
Showing
122 changed files
with
2,442 additions
and
12,076 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,117 @@ | ||
# Chess-D | ||
# Turborepo starter | ||
|
||
This is an official starter Turborepo. | ||
|
||
## Using this example | ||
|
||
Run the following command: | ||
|
||
```bash | ||
npx create-turbo@latest -e with-nestjs | ||
``` | ||
|
||
## What's inside? | ||
|
||
This Turborepo includes the following packages/apps: | ||
|
||
### Apps and Packages | ||
|
||
. | ||
├── apps | ||
│ ├── api # NestJS app (https://nestjs.com). | ||
│ └── web # Next.js app (https://nextjs.org). | ||
└── packages | ||
├── @repo/api # Shared `NestJS` resources. | ||
├── @repo/eslint-config # `eslint` configurations (includes `prettier`) | ||
├── @repo/jest-config # `jest` configurations | ||
├── @repo/typescript-config # `tsconfig.json`s used throughout the monorepo | ||
└── @repo/ui # Shareable stub React component library. | ||
|
||
Each package and application are 100% [TypeScript](https://www.typescriptlang.org/) safe. | ||
|
||
### Utilities | ||
|
||
This `Turborepo` has some additional tools already set for you: | ||
|
||
- [TypeScript](https://www.typescriptlang.org/) for static type-safety | ||
- [ESLint](https://eslint.org/) for code linting | ||
- [Prettier](https://prettier.io) for code formatting | ||
- [Jest](https://prettier.io) & [Playwright](https://playwright.dev/) for testing | ||
|
||
### Commands | ||
|
||
This `Turborepo` already configured useful commands for all your apps and packages. | ||
|
||
#### Build | ||
|
||
```bash | ||
# Will build all the app & packages with the supported `build` script. | ||
pnpm run build | ||
|
||
# ℹ️ If you plan to only build apps individually, | ||
# Please make sure you've built the packages first. | ||
``` | ||
|
||
#### Develop | ||
|
||
```bash | ||
# Will run the development server for all the app & packages with the supported `dev` script. | ||
pnpm run dev | ||
``` | ||
|
||
#### test | ||
|
||
```bash | ||
# Will launch a test suites for all the app & packages with the supported `test` script. | ||
pnpm run test | ||
|
||
# You can launch e2e testes with `test:e2e` | ||
pnpm run test:e2e | ||
|
||
# See `@repo/jest-config` to customize the behavior. | ||
``` | ||
|
||
#### Lint | ||
|
||
```bash | ||
# Will lint all the app & packages with the supported `lint` script. | ||
# See `@repo/eslint-config` to customize the behavior. | ||
pnpm run lint | ||
``` | ||
|
||
#### Format | ||
|
||
```bash | ||
# Will format all the supported `.ts,.js,json,.tsx,.jsx` files. | ||
# See `@repo/eslint-config/prettier-base.js` to customize the behavior. | ||
pnpm format | ||
``` | ||
|
||
### 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: | ||
|
||
```bash | ||
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: | ||
|
||
```bash | ||
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) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.