Overview

This document provides development notes for setting up a local development environment and making schema changes using PlanetScale and Prisma. It includes instructions for adding a database, promoting it to production, running a local PlanetScale proxy, defining Prisma schema, deploying schema changes, and resolving issues with the DATABASE_URL.

Features

• Database Management: Sign up at https://app.planetscale.com/ to create a new database and copy the DATABASE_URL to the .env file of your production environment.
• Promoting Databases: Promote the newly created database to production immediately in PlanetScale.
• PlanetScale CLI: Install the PlanetScale CLI (Command Line Interface) from https://planetscale.com/cli and log in to your PlanetScale account.
• Branching: Create a new branch from the main in PlanetScale.
• Local Proxy: Run the local PlanetScale proxy on the newly created branch.
• Schema Definition: Define your Prisma schema by referring to the prisma/schema.prisma file.
• Deploy Schema Changes: Merge the development branch in PlanetScale and deploy the schema changes.
• Branch Management: Delete any unused branches and list branches in PlanetScale.
• Troubleshooting: In case of issues with DATABASE_URL, add the .env file and run the necessary commands.

Installation

To install the theme and set up the development environment, follow the steps below:

1. Ensure that your database is running locally in another terminal.
2. Sign up at https://app.planetscale.com/ and create a new database.
3. Copy the DATABASE_URL from the newly created database and add it to the .env file in your production environment.
4. Promote the new database to production immediately within the PlanetScale platform.
5. Install the PlanetScale CLI from https://planetscale.com/cli and log in to your PlanetScale account.
6. Copy the environmental variables from the dist env.
7. Create a new branch from the main branch in PlanetScale.
8. Run the local PlanetScale proxy on the newly created branch.
9. Define your Prisma schema by referring to the prisma/schema.prisma file.
10. Push and merge the development branch in PlanetScale.
11. Deploy the schema changes in PlanetScale by reviewing the changes.
12. If there are any unused branches, delete them using the branch management functions in PlanetScale.
13. If you encounter any issues with the DATABASE_URL, make sure to add the .env file and run the necessary commands.

Summary

This document provides guidelines for setting up a local development environment, making schema changes using PlanetScale and Prisma, and resolving potential issues. The key features include database management, promoting databases, PlanetScale CLI usage, branching, local proxy setup, schema definition, schema deployment, branch management, and troubleshooting tips. By following these steps, developers can seamlessly work with PlanetScale and Prisma to manage their databases and make desired schema changes.