Onboarding

Setup

Planner requires Node v16+ and Python3.10. It also requires local environment variables since it uses Neon (hosted PostgresDB service), a SMTP server, and Discord as authentication provider.

Pre-requisites

To be able to start development on Planner make sure that you have the following pre-requisites installed:

• Node.js v16 or above

• Git

• Python3.11

Installation and Configuration

1. Clone repository and install web dependencies:

2. Copy .env.example file to .env:

   Copy the contents of the .env.example file at the root of the repo to a new file called .env.

3. Setting up Neon:

   Neon is a hosting service for PostgreSQL.

   1. Install the Neon CLI.

   2. Run neonctl auth and follow the on-screen prompts to login or create an account.

   3. Run neonctl projects create --name planner-dev to create a Neon project for Planner.

   4. Copy the string listed under 'Connection Uri' (ex: postgres://my-user:my-password@my-project-id.us-east-2.aws.neon.tech/neondb) and update the DATABASE_URL and DIRECT_DATABASE_URL variables in your .env file, as shown below.

      # Prisma DATABASE_URL="<your connection uri here>" DIRECT_DATABASE_URL="<your connection uri here>"

4. Apply database migrations:

   npx prisma migrate dev

5. Request PLATFORM_DATABASE_URL from someone on the team.

6. Set the NEXTAUTH_URL to http://localhost:3000 NEXTAUTH_SECRET to abc123.

7. Setting up an auth provider. You need at least one of these to log in. We recommend you only add Discord for convenience.

7. Run and configure validator

   1. Create a virtual environment:

   2. Activate the virtual environment:
      - Windows: venv\Scripts\activate
      - Linux/macOS: source venv/bin/activate

   3. Install dependencies:

   4. Run the validator:

   5. Add the validator to .env:

8. For any unused variables in your .env file, just leave them blank.

9. Generate Prisma client and run web server:

Overview of the tech stack: Tech Stack.