Quickstart

This is a quickstart guide to set up your development environment. Follow the steps below to install required tools, dependencies, and configure your environment variables.

1. Install Proto

   First, install proto by following the official installation instructions.

2. Install Required Tools

   Run the following command in your terminal to install all the tools required for development:

   proto install
   

   if you run into the following error No pre-built available for version 3.xx.xx use the command below to force proto to build Python from source:

    proto install python 3.xx.xx --build
   
3. Install Workspace Dependencies

   Next, install the workspace dependencies using:

   bun install
   
4. Configure Workspace Environment Variables

   1. Create a .env file in the root directory of the repository
   2. Access the development environment variables from 1Password
   3. Copy all variables from 1Password into your .env file
5. Connect With Neon

   1. Run the following command in your terminal:

   neonctl auth
   

   2. This will open a browser window. Log in with your Neon account to complete authentication.
   3. Once authenticated, your credentials will be stored locally for use with the Neon CLI.