diff --git a/README.md b/README.md index 1b798a3..bd25de7 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,9 @@ # Turborepo kitchen sink starter -This Turborepo starter is maintained by the Turborepo core team. +This Turborepo starter is scaffolded at 2025/06/19 using the [kitchen-sink template](https://vercel.com/templates/monorepos/turborepo-kitchensink) which is maintained by the Turborepo core team. It is heavily modified as a starter template for new Turborepos e-commerce projects but could also be used as a general-purpose monorepo starter. This example also shows how to use [Workspace Configurations](https://turborepo.com/docs/core-concepts/monorepos/configuring-workspaces). -## 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: @@ -21,12 +13,20 @@ This Turborepo includes the following packages and apps: - `express-template`: an [Express](https://expressjs.com/) server - `next-template`: a [Next.js](https://nextjs.org/) app - `vite-template`: a [Vite](https://vitejs.dev/) single page app -- `remix-template`: a [Remix](https://remix.run/) blog +- `remix-template`: a [Remix](https://remix.run/) app - `@repo/eslint-config`: ESLint configurations used throughout the monorepo +- `@repo/typescript-config`: tsconfig.json's used throughout the monorepo - `@repo/jest-presets`: Jest configurations - `@repo/logger`: isomorphic logger (a small wrapper around console.log) -- `@repo/ui`: a dummy React UI library (which contains `` and `` components) -- `@repo/typescript-config`: tsconfig.json's used throughout the monorepo +- `@repo/ui`: shared UI components for frontend use. + - A dummy React UI library (which contains `` and `` components) + - And shadcn/ui components (which contains `