Skip to content

Commit

Permalink
feat(examples): update READMEs for create-turbo
Browse files Browse the repository at this point in the history
  • Loading branch information
tknickman committed Apr 4, 2023
1 parent 2f6e12f commit b710441
Show file tree
Hide file tree
Showing 18 changed files with 104 additions and 67 deletions.
12 changes: 5 additions & 7 deletions examples/basic/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter Turborepo.

```sh
npx create-turbo@latest
```

## What's inside?

This Turborepo includes the following packages/apps:
Expand All @@ -26,16 +30,10 @@ This Turborepo has some additional tools already setup for you:

## 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"
npx create-turbo@latest
```

### Build
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
9 changes: 5 additions & 4 deletions examples/kitchen-sink/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter Turborepo with multiple meta-frameworks all working in harmony and sharing packages.

```sh
npx create-turbo@latest -e kitchen-sink
```

## What's inside?

This Turborepo includes the following packages and apps:
Expand Down Expand Up @@ -33,8 +37,5 @@ This Turborepo has some additional tools already setup for you:
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"
npx create-turbo@latest -e kitchen-sink
```
9 changes: 5 additions & 4 deletions examples/non-monorepo/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter Turborepo.

```sh
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.
Expand All @@ -11,10 +15,7 @@ This Turborepo uses a single, non-monorepo project (in this case, a single Next.
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
```

### Build
Expand Down
9 changes: 5 additions & 4 deletions examples/with-changesets/README.md
Expand Up @@ -2,6 +2,10 @@

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.

```sh
npx create-turbo@latest -e with-changesets
```

## What's inside?

This Turborepo includes the following:
Expand Down Expand Up @@ -29,10 +33,7 @@ This Turborepo has some additional tools already setup for you:
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"
npx create-turbo@latest -e with-changesets
```

### Useful commands
Expand Down
9 changes: 5 additions & 4 deletions examples/with-create-react-app/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter Turborepo.

```sh
npx create-turbo@latest -e with-create-react-app
```

## What's inside?

This Turborepo includes the following packages/apps:
Expand Down Expand Up @@ -30,8 +34,5 @@ This Turborepo has some additional tools already setup for you:
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"
npx create-turbo@latest -e with-create-react-app
```
9 changes: 5 additions & 4 deletions examples/with-docker/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official Docker starter Turborepo.

```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 @@ -24,10 +28,7 @@ Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
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"
npx create-turbo@latest -e with-docker
```

### Docker
Expand Down
12 changes: 12 additions & 0 deletions examples/with-gatsby/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter turborepo.

```sh
npx create-turbo@latest -e with-gatsby
```

## What's inside?

This Turborepo includes the following packages and apps:
Expand All @@ -24,6 +28,14 @@ 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 create-turbo@latest -e with-gatsby
```

### Build

To build all apps and packages, run the following command:
Expand Down
14 changes: 7 additions & 7 deletions examples/with-npm/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter Turborepo.

```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,16 +28,12 @@ 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
## Using this example

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:
Run the following command:

```sh
npx degit vercel/turbo/examples/with-npm with-npm
cd with-npm
npm install
git init . && git add . && git commit -m "Init"
npx create-turbo@latest -e with-npm
```

### Build
Expand Down
9 changes: 5 additions & 4 deletions examples/with-prisma/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter turborepo.

```sh
npx create-turbo@latest -e with-prisma
```

## What's inside?

This turborepo includes the following packages/apps:
Expand Down Expand Up @@ -79,10 +83,7 @@ For further more information on migrations, seeding & more, we recommend reading
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"
npx create-turbo@latest -e with-prisma
```

### Build
Expand Down
9 changes: 5 additions & 4 deletions examples/with-react-native-web/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter Turborepo.

```sh
npx create-turbo@latest -e with-react-native-web
```

## What's inside?

This Turborepo includes the following packages/apps:
Expand All @@ -28,8 +32,5 @@ This Turborepo has some additional tools already setup for you:
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"
npx create-turbo@latest -e with-react-native-web
```
12 changes: 12 additions & 0 deletions examples/with-rollup/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter Turborepo, showing how Turborepo can be used with Rollup for bundling a `ui` package.

```sh
npx create-turbo@latest -e with-rollup
```

## What's inside?

This Turborepo includes the following packages/apps:
Expand All @@ -23,6 +27,14 @@ 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 create-turbo@latest -e with-rollup
```

### Build

To build all apps and packages, run the following command:
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"
}
9 changes: 5 additions & 4 deletions examples/with-svelte/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter Turborepo.

```sh
npx create-turbo@latest -e with-svelte
```

## What's inside?

This Turborepo includes the following packages/apps:
Expand All @@ -28,8 +32,5 @@ This Turborepo has some additional tools already setup for you:
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"
npx create-turbo@latest -e with-svelte
```
9 changes: 5 additions & 4 deletions examples/with-tailwind/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter Turborepo.

```sh
npx create-turbo@latest -e with-tailwind
```

## What's inside?

This Turborepo includes the following packages/apps:
Expand Down Expand Up @@ -47,8 +51,5 @@ This Turborepo has some additional tools already setup for you:
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"
npx create-turbo@latest -e with-tailwind
```
9 changes: 5 additions & 4 deletions examples/with-vite/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter Turborepo.

```sh
npx create-turbo@latest -e with-vite
```

## What's inside?

This Turborepo includes the following packages and apps:
Expand Down Expand Up @@ -30,8 +34,5 @@ This Turborepo has some additional tools already setup for you:
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"
npx create-turbo@latest -e with-vite
```
4 changes: 4 additions & 0 deletions 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"
}
14 changes: 7 additions & 7 deletions examples/with-yarn/README.md
Expand Up @@ -2,6 +2,10 @@

This is an official starter Turborepo.

```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:
Expand All @@ -24,16 +28,12 @@ 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
## Using this example

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:
Run the following command:

```sh
npx degit vercel/turbo/examples/with-yarn with-yarn
cd with-yarn
yarn
git init . && git add . && git commit -m "Init"
npx create-turbo@latest -e with-yarn
```

### Build
Expand Down

0 comments on commit b710441

Please sign in to comment.