|
| 1 | +# Turborepo kitchen sink starter |
| 2 | + |
| 3 | +This is an official starter Turborepo with multiple meta-frameworks all working in harmony and sharing packages. |
| 4 | + |
| 5 | +This example also shows how to use [Workspace Configurations](https://turbo.build/repo/docs/core-concepts/monorepos/configuring-workspaces). |
| 6 | + |
| 7 | +## Using this example |
| 8 | + |
| 9 | +Run the following command: |
| 10 | + |
| 11 | +```sh |
| 12 | +npx create-turbo@latest -e kitchen-sink |
| 13 | +``` |
| 14 | + |
| 15 | +## What's inside? |
| 16 | + |
| 17 | +This Turborepo includes the following packages and apps: |
| 18 | + |
| 19 | +### Apps and Packages |
| 20 | + |
| 21 | +- `api`: an [Express](https://expressjs.com/) server |
| 22 | +- `storefront`: a [Next.js](https://nextjs.org/) app |
| 23 | +- `admin`: a [Vite](https://vitejs.dev/) single page app |
| 24 | +- `blog`: a [Remix](https://remix.run/) blog |
| 25 | +- `@repo/eslint-config`: ESLint configurations used throughout the monorepo |
| 26 | +- `@repo/jest-presets`: Jest configurations |
| 27 | +- `@repo/logger`: isomorphic logger (a small wrapper around console.log) |
| 28 | +- `@repo/ui`: a dummy React UI library (which contains `<CounterButton>` and `<Link>` components) |
| 29 | +- `@repo/typescript-config`: tsconfig.json's used throughout the monorepo |
| 30 | + |
| 31 | +Each package and app is 100% [TypeScript](https://www.typescriptlang.org/). |
| 32 | + |
| 33 | +### Utilities |
| 34 | + |
| 35 | +This Turborepo has some additional tools already setup for you: |
| 36 | + |
| 37 | +- [TypeScript](https://www.typescriptlang.org/) for static type checking |
| 38 | +- [ESLint](https://eslint.org/) for code linting |
| 39 | +- [Jest](https://jestjs.io) test runner for all things JavaScript |
| 40 | +- [Prettier](https://prettier.io) for code formatting |
0 commit comments