From ba4b3db71a1b188b827cfaa5a836dd33876a52cd Mon Sep 17 00:00:00 2001 From: Maaz Khokhar Date: Sun, 26 Apr 2026 23:07:13 -0500 Subject: [PATCH] readme :3 Co-authored-by: Copilot --- README.md | 167 ++++-------------------------------------------------- 1 file changed, 12 insertions(+), 155 deletions(-) diff --git a/README.md b/README.md index 90c1960..977256d 100644 --- a/README.md +++ b/README.md @@ -1,159 +1,16 @@ -# Turborepo starter +# Turborepo Starter Project -This Turborepo starter is maintained by the Turborepo core team. +## Tech Stack -## Using this example +- [Turborepo](https://turbo.build/) – Monorepo build system +- [Next.js](https://nextjs.org/) – React framework for web apps (client) +- [TypeScript](https://www.typescriptlang.org/) – Typed JavaScript +- [Node.js](https://nodejs.org/) – Backend runtime (server) +- [PostgreSQL](https://www.postgresql.org/) – Database (schema in server/lib/db/schema) +- [Redis](https://redis.io/) – Caching (server/lib/redis) +- [S3](https://aws.amazon.com/s3/) – Object storage (server/lib/s3) +- [Docker Compose](https://docs.docker.com/compose/) – Local development orchestration -Run the following command: +## Purpose -```sh -npx create-turbo@latest -``` - -## What's inside? - -This Turborepo includes the following packages/apps: - -### Apps and Packages - -- `docs`: a [Next.js](https://nextjs.org/) app -- `web`: another [Next.js](https://nextjs.org/) app -- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications -- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) -- `@repo/typescript-config`: `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 -- [Prettier](https://prettier.io) for code formatting - -### Build - -To build all apps and packages, run the following command: - -With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended): - -```sh -cd my-turborepo -turbo build -``` - -Without global `turbo`, use your package manager: - -```sh -cd my-turborepo -npx turbo build -bun dlx turbo build -bun exec turbo build -``` - -You can build a specific package by using a [filter](https://turborepo.dev/docs/crafting-your-repository/running-tasks#using-filters): - -With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed: - -```sh -turbo build --filter=docs -``` - -Without global `turbo`: - -```sh -npx turbo build --filter=docs -bun exec turbo build --filter=docs -bun exec turbo build --filter=docs -``` - -### Develop - -To develop all apps and packages, run the following command: - -With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended): - -```sh -cd my-turborepo -turbo dev -``` - -Without global `turbo`, use your package manager: - -```sh -cd my-turborepo -npx turbo dev -bun exec turbo dev -bun exec turbo dev -``` - -You can develop a specific package by using a [filter](https://turborepo.dev/docs/crafting-your-repository/running-tasks#using-filters): - -With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed: - -```sh -turbo dev --filter=web -``` - -Without global `turbo`: - -```sh -npx turbo dev --filter=web -bun exec turbo dev --filter=web -bun exec turbo dev --filter=web -``` - -### Remote Caching - -> [!TIP] -> Vercel Remote Cache is free for all plans. Get started today at [vercel.com](https://vercel.com/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache). - -Turborepo can use a technique known as [Remote Caching](https://turborepo.dev/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines. - -By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup?utm_source=turborepo-examples), then enter the following commands: - -With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed (recommended): - -```sh -cd my-turborepo -turbo login -``` - -Without global `turbo`, use your package manager: - -```sh -cd my-turborepo -npx turbo login -bun exec turbo login -bun exec turbo login -``` - -This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview). - -Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo: - -With [global `turbo`](https://turborepo.dev/docs/getting-started/installation#global-installation) installed: - -```sh -turbo link -``` - -Without global `turbo`: - -```sh -npx turbo link -bun exec turbo link -bun exec turbo link -``` - -## Useful Links - -Learn more about the power of Turborepo: - -- [Tasks](https://turborepo.dev/docs/crafting-your-repository/running-tasks) -- [Caching](https://turborepo.dev/docs/crafting-your-repository/caching) -- [Remote Caching](https://turborepo.dev/docs/core-concepts/remote-caching) -- [Filtering](https://turborepo.dev/docs/crafting-your-repository/running-tasks#using-filters) -- [Configuration Options](https://turborepo.dev/docs/reference/configuration) -- [CLI Usage](https://turborepo.dev/docs/reference/command-line-reference) +This repository provides boilerplate code for quickly starting new full-stack projects using a modern monorepo setup. It includes pre-configured client and server apps, shared tooling, and example integrations for authentication, database, caching, and storage.