diff --git a/examples/basic/README.md b/examples/basic/README.md index 76b5a33862ea4..bc389a063103e 100644 --- a/examples/basic/README.md +++ b/examples/basic/README.md @@ -2,6 +2,14 @@ This is an official starter Turborepo. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest +``` + ## What's inside? This Turborepo includes the following packages/apps: @@ -24,20 +32,6 @@ This Turborepo has some additional tools already setup for you: - [ESLint](https://eslint.org/) for code linting - [Prettier](https://prettier.io) for code formatting -## Using this example - -This repository is used with `npx create-turbo@latest` command, but you can also use `degit` to -download and run this example, like the other examples. - -Run the following command: - -```sh -npx degit vercel/turbo/examples/basic basic -cd basic -pnpm install -git init . && git add . && git commit -m "Init" -``` - ### Build To build all apps and packages, run the following command: diff --git a/examples/design-system/README.md b/examples/design-system/README.md index b733050cc0469..d9da6538e451f 100644 --- a/examples/design-system/README.md +++ b/examples/design-system/README.md @@ -17,13 +17,10 @@ As well as a few others tools preconfigured: ## Using this example -Clone the design system example locally or [from GitHub](https://github.com/vercel/turbo/tree/main/examples/design-system): +Run the following command: -```bash -npx degit vercel/turbo/examples/design-system design-system -cd design-system -pnpm install -git init . && git add . && git commit -m "Init" +```sh +npx create-turbo@latest -e design-system ``` ### Useful Commands diff --git a/examples/kitchen-sink/README.md b/examples/kitchen-sink/README.md index 0b3cd227114ae..7e01b4185f083 100644 --- a/examples/kitchen-sink/README.md +++ b/examples/kitchen-sink/README.md @@ -2,6 +2,14 @@ This is an official starter Turborepo with multiple meta-frameworks all working in harmony and sharing packages. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e kitchen-sink +``` + ## What's inside? This Turborepo includes the following packages and apps: @@ -27,14 +35,3 @@ This Turborepo has some additional tools already setup for you: - [ESLint](https://eslint.org/) for code linting - [Jest](https://jestjs.io) test runner for all things JavaScript - [Prettier](https://prettier.io) for code formatting - -## Using this example - -Run the following command: - -```sh -npx degit vercel/turbo/examples/kitchen-sink kitchen-sink -cd kitchen-sink -pnpm install -git init . && git add . && git commit -m "Init" -``` diff --git a/examples/non-monorepo/README.md b/examples/non-monorepo/README.md index 0a972a322dcfd..ba2ecaf3decc6 100644 --- a/examples/non-monorepo/README.md +++ b/examples/non-monorepo/README.md @@ -2,21 +2,18 @@ This is an official starter Turborepo. -## What's inside? - -This Turborepo uses a single, non-monorepo project (in this case, a single Next.js application). Since [Turborepo 1.6](https://turbo.build/blog/turbo-1-6-0#any-codebase-can-use-turborepo), you can use Turborepo for non-monorepo projects as well as monorepos. - ## Using this example Run the following command: ```sh -npx degit vercel/turbo/examples/non-monorepo non-monorepo -cd non-monorepo -pnpm install -git init . && git add . && git commit -m "Init" +npx create-turbo@latest -e non-monorepo ``` +## What's inside? + +This Turborepo uses a single, non-monorepo project (in this case, a single Next.js application). Since [Turborepo 1.6](https://turbo.build/blog/turbo-1-6-0#any-codebase-can-use-turborepo), you can use Turborepo for non-monorepo projects as well as monorepos. + ### Build To build all apps and packages, run the following command: diff --git a/examples/with-changesets/README.md b/examples/with-changesets/README.md index ff524e4c64b4a..8cae92e9fcaf4 100644 --- a/examples/with-changesets/README.md +++ b/examples/with-changesets/README.md @@ -2,6 +2,14 @@ This is an official React design system starter powered by Turborepo. Versioning and package publishing is handled by [Changesets](https://github.com/changesets/changesets) and fully automated with GitHub Actions. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-changesets +``` + ## What's inside? This Turborepo includes the following: @@ -24,17 +32,6 @@ This Turborepo has some additional tools already setup for you: - [ESLint](https://eslint.org/) for code linting - [Prettier](https://prettier.io) for code formatting -## Using this example - -Run the following command: - -```sh -npx degit vercel/turbo/examples/with-changesets with-changesets -cd with-changesets -pnpm install -git init . && git add . && git commit -m "Init" -``` - ### Useful commands - `yarn build` - Build all packages and the docs site diff --git a/examples/with-create-react-app/README.md b/examples/with-create-react-app/README.md index 3e9c7706be67b..56aba64b0385e 100644 --- a/examples/with-create-react-app/README.md +++ b/examples/with-create-react-app/README.md @@ -2,6 +2,14 @@ This is an official starter Turborepo. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-create-react-app +``` + ## What's inside? This Turborepo includes the following packages/apps: @@ -24,14 +32,3 @@ This Turborepo has some additional tools already setup for you: - [ESLint](https://eslint.org/) for code linting - [Jest](https://jestjs.io) test runner for all things JavaScript - [Prettier](https://prettier.io) for code formatting - -## Using this example - -Run the following command: - -```sh -npx degit vercel/turbo/examples/with-create-react-app with-create-react-app -cd with-create-react-app -pnpm install -git init . && git add . && git commit -m "Init" -``` diff --git a/examples/with-docker/README.md b/examples/with-docker/README.md index 73f90855bccdd..e95623f0b2542 100644 --- a/examples/with-docker/README.md +++ b/examples/with-docker/README.md @@ -2,6 +2,14 @@ This is an official Docker starter Turborepo. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-docker +``` + ## What's inside? This turborepo uses [Yarn](https://classic.yarnpkg.com/lang/en/) as a package manager. It includes the following packages/apps: @@ -19,17 +27,6 @@ This turborepo uses [Yarn](https://classic.yarnpkg.com/lang/en/) as a package ma Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). -## Using this example - -Run the following command: - -```sh -npx degit vercel/turbo/examples/with-docker with-docker -cd with-docker -yarn install -git init . && git add . && git commit -m "Init" -``` - ### Docker This repo is configured to be built with Docker, and Docker compose. To build all apps in this repo: diff --git a/examples/with-gatsby/README.md b/examples/with-gatsby/README.md index 6c27c39195940..ea974f4ded8b4 100644 --- a/examples/with-gatsby/README.md +++ b/examples/with-gatsby/README.md @@ -2,6 +2,14 @@ This is an official starter turborepo. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-gatsby +``` + ## What's inside? This Turborepo includes the following packages and apps: diff --git a/examples/with-npm/README.md b/examples/with-npm/README.md index bfb8f7feee89e..88ae67d241a74 100644 --- a/examples/with-npm/README.md +++ b/examples/with-npm/README.md @@ -2,6 +2,14 @@ This is an official starter Turborepo. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-npm +``` + ## What's inside? This Turborepo uses [npm](https://www.npmjs.com/) as a packages manager. It includes the following packages/apps: @@ -24,18 +32,6 @@ This Turborepo has some additional tools already setup for you: - [ESLint](https://eslint.org/) for code linting - [Prettier](https://prettier.io) for code formatting -## Setup - -This repository can be used by running `npx create-turbo@latest`, and selecting `npm` in the terminal prompt, -or you can also download this folder like all the other examples with: - -```sh -npx degit vercel/turbo/examples/with-npm with-npm -cd with-npm -npm install -git init . && git add . && git commit -m "Init" -``` - ### Build To build all apps and packages, run the following command: diff --git a/examples/with-prisma/README.md b/examples/with-prisma/README.md index 88eacfbb2e98f..57587d39b3e90 100644 --- a/examples/with-prisma/README.md +++ b/examples/with-prisma/README.md @@ -2,6 +2,14 @@ This is an official starter turborepo. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-prisma +``` + ## What's inside? This turborepo includes the following packages/apps: @@ -74,17 +82,6 @@ yarn run db:seed For further more information on migrations, seeding & more, we recommend reading through the [Prisma Documentation](https://www.prisma.io/docs/). -## Using this example - -Run the following command: - -```sh -npx degit vercel/turbo/examples/with-prisma with-prisma -cd with-prisma -yarn install -git init . && git add . && git commit -m "Init" -``` - ### Build To build all apps and packages, run the following command: diff --git a/examples/with-react-native-web/README.md b/examples/with-react-native-web/README.md index 67f5b705a6dc0..327ca66402e97 100644 --- a/examples/with-react-native-web/README.md +++ b/examples/with-react-native-web/README.md @@ -2,6 +2,14 @@ This is an official starter Turborepo. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-react-native-web +``` + ## What's inside? This Turborepo includes the following packages/apps: @@ -22,14 +30,3 @@ This Turborepo has some additional tools already setup for you: - [Expo](https://docs.expo.dev/) for native development - [TypeScript](https://www.typescriptlang.org/) for static type checking - [Prettier](https://prettier.io) for code formatting - -## Using this example - -Run the following command: - -```sh -npx degit vercel/turbo/examples/with-react-native-web with-react-native-web -cd with-react-native-web -yarn install -git init . && git add . && git commit -m "Init" -``` diff --git a/examples/with-rollup/README.md b/examples/with-rollup/README.md index 1c6aaf4075d3e..925501c04ecaf 100644 --- a/examples/with-rollup/README.md +++ b/examples/with-rollup/README.md @@ -2,6 +2,14 @@ This is an official starter Turborepo, showing how Turborepo can be used with Rollup for bundling a `ui` package. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-rollup +``` + ## What's inside? This Turborepo includes the following packages/apps: diff --git a/examples/with-rollup/meta.json b/examples/with-rollup/meta.json new file mode 100644 index 0000000000000..8f3a2476045e7 --- /dev/null +++ b/examples/with-rollup/meta.json @@ -0,0 +1,4 @@ +{ + "name": "Rollup", + "description": "Monorepo with a single Next.js app sharing a UI library bundled with Rollup" +} diff --git a/examples/with-svelte/README.md b/examples/with-svelte/README.md index e66e4696506aa..8b8478b2529f8 100644 --- a/examples/with-svelte/README.md +++ b/examples/with-svelte/README.md @@ -2,6 +2,14 @@ This is an official starter Turborepo. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-svelte +``` + ## What's inside? This Turborepo includes the following packages/apps: @@ -22,14 +30,3 @@ 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 - -## Using this example - -Run the following command: - -```sh -npx degit vercel/turbo/examples/with-svelte with-svelte -cd with-svelte -pnpm install -git init . && git add . && git commit -m "Init" -``` diff --git a/examples/with-tailwind/README.md b/examples/with-tailwind/README.md index 8186afee28c81..2b95be1d78bab 100644 --- a/examples/with-tailwind/README.md +++ b/examples/with-tailwind/README.md @@ -2,6 +2,14 @@ This is an official starter Turborepo. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-tailwind +``` + ## What's inside? This Turborepo includes the following packages/apps: @@ -41,14 +49,3 @@ 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 - -## Using this example - -Run the following command: - -```sh -npx degit vercel/turbo/examples/with-tailwind with-tailwind -cd with-tailwind -pnpm install -git init . && git add . && git commit -m "Init" -``` diff --git a/examples/with-vite/README.md b/examples/with-vite/README.md index 2d3b266bf640b..872fb48e52cef 100644 --- a/examples/with-vite/README.md +++ b/examples/with-vite/README.md @@ -2,6 +2,14 @@ This is an official starter Turborepo. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-vite +``` + ## What's inside? This Turborepo includes the following packages and apps: @@ -24,14 +32,3 @@ This Turborepo has some additional tools already setup for you: - [ESLint](https://eslint.org/) for code linting - [Jest](https://jestjs.io) test runner for all things JavaScript - [Prettier](https://prettier.io) for code formatting - -## Using this example - -Run the following command: - -```sh -npx degit vercel/turbo/examples/with-vite with-vite -cd with-vite -pnpm install -git init . && git add . && git commit -m "Init" -``` diff --git a/examples/with-vite/meta.json b/examples/with-vite/meta.json new file mode 100644 index 0000000000000..3432702d5fa60 --- /dev/null +++ b/examples/with-vite/meta.json @@ -0,0 +1,4 @@ +{ + "name": "Vite", + "description": "Monorepo with multiple Vanilla JS apps bundled with Vite, sharing a UI Library" +} diff --git a/examples/with-yarn/README.md b/examples/with-yarn/README.md index 04b3ae44893eb..3064b11f32e51 100644 --- a/examples/with-yarn/README.md +++ b/examples/with-yarn/README.md @@ -2,6 +2,14 @@ This is an official starter Turborepo. +## Using this example + +Run the following command: + +```sh +npx create-turbo@latest -e with-yarn +``` + ## What's inside? This Turborepo uses [yarn](https://classic.yarnpkg.com/lang/en/) as a packages manager. It includes the following packages/apps: @@ -24,18 +32,6 @@ This Turborepo has some additional tools already setup for you: - [ESLint](https://eslint.org/) for code linting - [Prettier](https://prettier.io) for code formatting -## Setup - -This repository can be used by running `npx create-turbo@latest`, and selecting `yarn` in the terminal prompt, -or you can also download this folder like all the other examples with: - -```sh -npx degit vercel/turbo/examples/with-yarn with-yarn -cd with-yarn -yarn -git init . && git add . && git commit -m "Init" -``` - ### Build To build all apps and packages, run the following command: