Turborepo starter

Getting Started

This is a Turborepo that uses Docker for containerization.

Using Docker

To start the development environment with Docker, run the following command:

docker-compose up

Without Docker

If you prefer to run the development environment without Docker, follow these steps:

1. Install dependencies at the root of the monorepo:

   npm install

2. Navigate to the packages/db directory and run the following commands to set up the database:

   npx prisma migrate dev --name init
   npx prisma generate
   npx prisma db seed

3. Install dependencies and start the webhook-handler app:

   cd apps/webhook-handler
   npm install
   npm run start

4. Install dependencies and start the user app:

   cd apps/user-app
   npm install
   npm run dev/start

You can edit the ports for the applications in their respective package.json files.

This is an official starter Turborepo.

Using this example

Run the following command:

npx create-turbo@latest

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

• docs: a Next.js app
• web: another Next.js 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.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Utilities

This Turborepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Build

To build all apps and packages, run the following command:

cd my-turborepo
pnpm build

Develop

To develop all apps and packages, run the following command:

cd my-turborepo
pnpm dev

Remote Caching

Turborepo can use a technique known as 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, then enter the following commands:

cd my-turborepo
npx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:

npx turbo link

Useful Links

Learn more about the power of Turborepo:

• Tasks
• Caching
• Remote Caching
• Filtering
• Configuration Options
• CLI Usage