Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(examples): update READMEs for create-turbo #4451

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 8 additions & 14 deletions examples/basic/README.md
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
9 changes: 3 additions & 6 deletions examples/design-system/README.md
Expand Up @@ -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
Expand Down
19 changes: 8 additions & 11 deletions examples/kitchen-sink/README.md
Expand Up @@ -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:
Expand All @@ -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"
```
13 changes: 5 additions & 8 deletions examples/non-monorepo/README.md
Expand Up @@ -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:
Expand Down
19 changes: 8 additions & 11 deletions examples/with-changesets/README.md
Expand Up @@ -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:
Expand All @@ -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
Expand Down
19 changes: 8 additions & 11 deletions examples/with-create-react-app/README.md
Expand Up @@ -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:
Expand All @@ -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"
```
19 changes: 8 additions & 11 deletions examples/with-docker/README.md
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
8 changes: 8 additions & 0 deletions examples/with-gatsby/README.md
Expand Up @@ -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:
Expand Down
20 changes: 8 additions & 12 deletions examples/with-npm/README.md
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
19 changes: 8 additions & 11 deletions examples/with-prisma/README.md
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
19 changes: 8 additions & 11 deletions examples/with-react-native-web/README.md
Expand Up @@ -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:
Expand All @@ -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"
```
8 changes: 8 additions & 0 deletions examples/with-rollup/README.md
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions 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"
}
19 changes: 8 additions & 11 deletions examples/with-svelte/README.md
Expand Up @@ -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:
Expand All @@ -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"
```
19 changes: 8 additions & 11 deletions examples/with-tailwind/README.md
Expand Up @@ -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:
Expand Down Expand Up @@ -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"
```