docs(turborepo): update README with deployment instructions and environment variable setup
This commit is contained in:
@@ -1,84 +1,30 @@
|
|||||||
# Turborepo starter
|
# Turborepo Example
|
||||||
|
|
||||||
This Turborepo starter is maintained by the Turborepo core team.
|
This repository contains an example of turborepo application that is deployed on Dokploy.
|
||||||
|
|
||||||
## Using this example
|
|
||||||
|
|
||||||
Run the following command:
|
1. **Use Git Provider in Your Application**:
|
||||||
|
- Repository: `https://github.com/Dokploy/examples.git`
|
||||||
|
- Branch: `main`
|
||||||
|
- Build path: `/turborepo` (Nixpacks)
|
||||||
|
|
||||||
```sh
|
2. **Environment Variables**:
|
||||||
npx create-turbo@latest
|
- Add environment variables to the env tab.
|
||||||
```
|
|
||||||
|
|
||||||
## What's inside?
|
```bash
|
||||||
|
NIXPACKS_TURBO_APP_NAME="web"
|
||||||
|
NIXPACKS_BUILD_CMD="turbo run build --filter=web"
|
||||||
|
NIXPACKS_START_CMD="turbo run start --filter=web"
|
||||||
|
```
|
||||||
|
|
||||||
This Turborepo includes the following packages/apps:
|
3. **Click on Deploy**:
|
||||||
|
- Deploy your application by clicking the deploy button.
|
||||||
|
|
||||||
### Apps and Packages
|
3. **Generate a Domain**:
|
||||||
|
- Click on generate domain button.
|
||||||
|
- A new domain will be generated for you.
|
||||||
|
- Set Port `3000`
|
||||||
|
- You can use this domain to access your application.
|
||||||
|
|
||||||
- `docs`: a [Next.js](https://nextjs.org/) app
|
|
||||||
- `web`: another [Next.js](https://nextjs.org/) app
|
If you need further assistance, join our [Discord server](https://discord.com/invite/2tBnJ3jDJc).
|
||||||
- `@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 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
|
|
||||||
|
|
||||||
### Build
|
|
||||||
|
|
||||||
To build all apps and packages, run the following command:
|
|
||||||
|
|
||||||
```
|
|
||||||
cd my-turborepo
|
|
||||||
pnpm build
|
|
||||||
```
|
|
||||||
|
|
||||||
### Develop
|
|
||||||
|
|
||||||
To develop all apps and packages, run the following command:
|
|
||||||
|
|
||||||
```
|
|
||||||
cd my-turborepo
|
|
||||||
pnpm dev
|
|
||||||
```
|
|
||||||
|
|
||||||
### Remote Caching
|
|
||||||
|
|
||||||
> [!TIP]
|
|
||||||
> Vercel Remote Cache is free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).
|
|
||||||
|
|
||||||
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?utm_source=turborepo-examples), 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)
|
|
||||||
|
|||||||
Reference in New Issue
Block a user