diff options
Diffstat (limited to 'examples/with-create-react-app/README.md')
| -rw-r--r-- | examples/with-create-react-app/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/examples/with-create-react-app/README.md b/examples/with-create-react-app/README.md new file mode 100644 index 0000000..56aba64 --- /dev/null +++ b/examples/with-create-react-app/README.md @@ -0,0 +1,34 @@ +# Turborepo Create React App starter + +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: + +### Apps and Packages + +- `docs`: a [create-react-app](https://create-react-app.dev) app +- `web`: another [create-react-app](https://create-react-app.dev) app +- `ui`: a stub React component library shared by both `web` and `docs` applications +- `eslint-config-custom`: `eslint` configurations (includes `eslint-plugin-react` and `eslint-config-prettier`) +- `tsconfig`: `tsconfig.json`s used throughout the monorepo + +Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). + +### Utilities + +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 +- [Jest](https://jestjs.io) test runner for all things JavaScript +- [Prettier](https://prettier.io) for code formatting |