| 1 | # Turborepo starter |
| 2 | |
| 3 | This Turborepo starter is maintained by the Turborepo core team. |
| 4 | |
| 5 | ## Using this example |
| 6 | |
| 7 | Run the following command: |
| 8 | |
| 9 | ```sh |
| 10 | npx create-turbo@latest |
| 11 | ``` |
| 12 | |
| 13 | ## What's inside? |
| 14 | |
| 15 | This Turborepo includes the following packages/apps: |
| 16 | |
| 17 | ### Apps and Packages |
| 18 | |
| 19 | - `docs`: a [Next.js |
| 20 | - `web`: another [Next.js |
| 21 | - `@repo/ui`: a stub React component library shared by both `web` and |
| 22 | - `@repo/eslint-config`: `eslint` configurations (includes |
| 23 | - `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo |
| 24 | |
| 25 | Each package/app is 100% [TypeScript](https://www.typescriptlang.org/ |
| 26 | |
| 27 | ### Utilities |
| 28 | |
| 29 | This Turborepo has some additional tools already setup for you: |
| 30 | |
| 31 | - [TypeScript](https://www.typescriptlang.org/ |
| 32 | - [ESLint](https://eslint.org/ |
| 33 | - [Prettier](https://prettier.io |
| 34 | |
| 35 | ### Build |
| 36 | |
| 37 | To build all apps and packages, run the following command: |
| 38 | |
| 39 | ``` |
| 40 | cd my-turborepo |
| 41 | |
| 42 | # With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended) |
| 43 | turbo build |
| 44 | |
| 45 | # Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager |
| 46 | npx turbo build |
| 47 | yarn dlx turbo build |
| 48 | pnpm exec turbo build |
| 49 | ``` |
| 50 | |
| 51 | You can build a specific package by using a [filter](https://turborepo.com/docs/crafting-your-repository/running-tasks#using-filters |
| 52 | |
| 53 | ``` |
| 54 | # With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended) |
| 55 | turbo build --filter=docs |
| 56 | |
| 57 | # Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager |
| 58 | npx turbo build --filter=docs |
| 59 | yarn exec turbo build --filter=docs |
| 60 | pnpm exec turbo build --filter=docs |
| 61 | ``` |
| 62 | |
| 63 | ### Develop |
| 64 | |
| 65 | To develop all apps and packages, run the following command: |
| 66 | |
| 67 | ``` |
| 68 | cd my-turborepo |
| 69 | |
| 70 | # With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended) |
| 71 | turbo dev |
| 72 | |
| 73 | # Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager |
| 74 | npx turbo dev |
| 75 | yarn exec turbo dev |
| 76 | pnpm exec turbo dev |
| 77 | ``` |
| 78 | |
| 79 | You can develop a specific package by using a [filter](https://turborepo.com/docs/crafting-your-repository/running-tasks#using-filters |
| 80 | |
| 81 | ``` |
| 82 | # With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended) |
| 83 | turbo dev --filter=web |
| 84 | |
| 85 | # Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager |
| 86 | npx turbo dev --filter=web |
| 87 | yarn exec turbo dev --filter=web |
| 88 | pnpm exec turbo dev --filter=web |
| 89 | ``` |
| 90 | |
| 91 | ### Remote Caching |
| 92 | |
| 93 | > [!TIP |
| 94 | > Vercel Remote Cache is free for all plans. Get started today at [vercel.com |
| 95 | |
| 96 | Turborepo can use a technique known as [Remote Caching](https://turborepo.com/docs/core-concepts/remote-caching |
| 97 | |
| 98 | 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 |
| 99 | |
| 100 | ``` |
| 101 | cd my-turborepo |
| 102 | |
| 103 | # With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended) |
| 104 | turbo login |
| 105 | |
| 106 | # Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager |
| 107 | npx turbo login |
| 108 | yarn exec turbo login |
| 109 | pnpm exec turbo login |
| 110 | ``` |
| 111 | |
| 112 | This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview |
| 113 | |
| 114 | Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo: |
| 115 | |
| 116 | ``` |
| 117 | # With [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation) installed (recommended) |
| 118 | turbo link |
| 119 | |
| 120 | # Without [global `turbo`](https://turborepo.com/docs/getting-started/installation#global-installation), use your package manager |
| 121 | npx turbo link |
| 122 | yarn exec turbo link |
| 123 | pnpm exec turbo link |
| 124 | ``` |
| 125 | |
| 126 | ## Useful Links |
| 127 | |
| 128 | Learn more about the power of Turborepo: |
| 129 | |
| 130 | - [Tasks](https://turborepo.com/docs/crafting-your-repository/running-tasks |
| 131 | - [Caching](https://turborepo.com/docs/crafting-your-repository/caching |
| 132 | - [Remote Caching](https://turborepo.com/docs/core-concepts/remote-caching |
| 133 | - [Filtering](https://turborepo.com/docs/crafting-your-repository/running-tasks#using-filters |
| 134 | - [Configuration Options](https://turborepo.com/docs/reference/configuration |
| 135 | - [CLI Usage](https://turborepo.com/docs/reference/command-line-reference |