https://github.com/narsibhati-dev/turborepo_prisma
https://github.com/narsibhati-dev/turborepo_prisma
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/narsibhati-dev/turborepo_prisma
- Owner: NarsiBhati-Dev
- Created: 2024-09-18T15:15:17.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-19T05:30:17.000Z (9 months ago)
- Last Synced: 2025-01-15T20:41:35.546Z (5 months ago)
- Language: TypeScript
- Size: 327 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Here's a new `README.md` for your Turborepo setup, tailored to include the specific details of your configuration and how to manage migrations:
# Turborepo Starter
Welcome to the Turborepo starter project!
This repository includes a Turborepo setup with various applications and packages, designed to manage a monorepo efficiently.
## Contents
### Apps and Packages
- `docs`: A [Next.js](https://nextjs.org/) application for documentation.
- `web`: Another [Next.js](https://nextjs.org/) application for your main site.
- `@repo/ui`: A shared React component library used by both `web` and `docs` applications.
- `@repo/eslint-config`: ESLint configurations, including `eslint-config-next` and `eslint-config-prettier`.
- `@repo/typescript-config`: TypeScript configurations (`tsconfig.json`) used across the monorepo.
### Utilities
This Turborepo comes with several tools pre-configured:
- [TypeScript](https://www.typescriptlang.org/) for static type checking.
- [ESLint](https://eslint.org/) for code linting.
- [Prettier](https://prettier.io) for code formatting.
## Getting Started
### Installation
To set up the project, follow these steps:
1. Clone the repository:
```sh
git clone
cd
```
2. Install dependencies:
```sh
bun install
```
### Development
To develop all apps and packages, run:
```sh
bun run dev
```
This command will start all applications and monitor changes.
### Build
To build all apps and packages, run:
```sh
bun run build
```
### Database Migrations
To handle database migrations, you can use the following scripts:
- **Generate Prisma Client:** `bun run db:generate`
- **Push Prisma Schema to Database:** `bun run db:push`
- **Run Migrations in Development:** `bun run db:migrate:dev`
- **Deploy Migrations:** `bun run db:migrate`
You can use these commands to manage your database schema and migrations across the monorepo.
### Remote Caching
To enable remote caching with Turborepo, you'll need a Vercel account. Follow these steps:
1. Authenticate with Vercel:
```sh
npx turbo login
```
2. Link your Turborepo to the remote cache:
```sh
npx turbo link
```
### Useful Links
Learn more about Turborepo:
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
```sh
### Explanation
- Installation: Details the steps for setting up the project.
- Development and Build: Commands to start development and build the project.
- Database Migrations: Specific commands for managing Prisma migrations.
- Remote Caching: Instructions for enabling remote caching with Vercel.
- Useful Links:Provides resources for learning more about Turborepo.
You can adjust or expand upon this `README.md` based on additional details or specific configurations of your project.
```