aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/examples/kitchen-sink/README.md
diff options
context:
space:
mode:
author简律纯 <hsiangnianian@outlook.com>2023-04-28 01:47:57 +0800
committer简律纯 <hsiangnianian@outlook.com>2023-04-28 01:47:57 +0800
commit8b2c4a38a461ff5ecc95972291bc711e2c5dec9a (patch)
tree29f552e3df949073e21bf5c76d7abc3044830ec6 /examples/kitchen-sink/README.md
parentfc8c5fdce62fb229202659408798a7b6c98f6e8b (diff)
downloadHydroRoll-8b2c4a38a461ff5ecc95972291bc711e2c5dec9a.tar.gz
HydroRoll-8b2c4a38a461ff5ecc95972291bc711e2c5dec9a.zip
Diffstat (limited to 'examples/kitchen-sink/README.md')
-rw-r--r--examples/kitchen-sink/README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/examples/kitchen-sink/README.md b/examples/kitchen-sink/README.md
new file mode 100644
index 0000000..7e01b41
--- /dev/null
+++ b/examples/kitchen-sink/README.md
@@ -0,0 +1,37 @@
+# Turborepo kitchen sink starter
+
+This is an official starter Turborepo with multiple meta-frameworks all working in harmony and sharing packages.
+
+## Using this example
+
+Run the following command:
+
+```sh
+npx create-turbo@latest -e kitchen-sink
+```
+
+## What's inside?
+
+This Turborepo includes the following packages and apps:
+
+### Apps and Packages
+
+- `api`: an [Express](https://expressjs.com/) server
+- `storefront`: a [Next.js](https://nextjs.org/) app
+- `admin`: a [Vite](https://vitejs.dev/) single page app
+- `blog`: a [Remix](https://remix.run/) blog
+- `logger`: isomorphic logger (a small wrapper around console.log)
+- `ui`: a dummy React UI library (which contains a single `<CounterButton>` component)
+- `scripts`: Jest and 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