diff options
Diffstat (limited to 'examples/with-vite/README.md')
| -rw-r--r-- | examples/with-vite/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/examples/with-vite/README.md b/examples/with-vite/README.md new file mode 100644 index 0000000..872fb48 --- /dev/null +++ b/examples/with-vite/README.md @@ -0,0 +1,34 @@ +# `Turborepo` Vite starter + +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: + +### Apps and Packages + +- `docs`: a vanilla [vite](https://vitejs.dev) ts app +- `web`: another vanilla [vite](https://vitejs.dev) ts app +- `ui`: a stub component & utility library shared by both `web` and `docs` applications +- `eslint-config-custom`: shared `eslint` configurations +- `tsconfig`: `tsconfig.json`s used throughout the monorepo + +Each package and 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 |