diff options
Diffstat (limited to 'examples/with-svelte/README.md')
| -rw-r--r-- | examples/with-svelte/README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/examples/with-svelte/README.md b/examples/with-svelte/README.md new file mode 100644 index 0000000..8b8478b --- /dev/null +++ b/examples/with-svelte/README.md @@ -0,0 +1,32 @@ +# Turborepo Svelte starter + +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: + +### Apps and Packages + +- `docs`: a [svelte-kit](https://kit.svelte.dev/) app +- `web`: another [svelte-kit](https://kit.svelte.dev/) app +- `ui`: a stub Svelte component library shared by both `web` and `docs` applications +- `eslint-config-custom`: `eslint` configurations (includes `eslint-plugin-svelte` and `eslint-config-prettier`) + +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 +- [Prettier](https://prettier.io) for code formatting |