...
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
.Setting up Neon:
Neon is a hosting service for PostgreSQL.
Install the Neon CLI.
Run
neonctl auth
and follow the on-screen prompts to login or create an account.Run
neonctl projects create --name planner-dev
to create a Neon project for Planner.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 theDATABASE_URL
andDIRECT_DATABASE_URL
variables in your.env
file, as shown below.Code Block language bash # Prisma DATABASE_URL="<your connection uri here>" DIRECT_DATABASE_URL="<your connection uri here>"
Apply database migrations:
Code Block language bash npx prisma migrate dev
Request
PLATFORM_DATABASE_URL
from someone on the team.Set the
NEXTAUTH_URL
tohttpshttp://localhost:3000
NEXTAUTH_SECRET
toabc123
.Setting up an auth provider. You need at least one of these to log in. We recommend you only add Discord for convenience.
...
Run and configure validator
Create a virtual environment:
Code Block cd validator python3.10 -m venv venv # Create virtual environment
Activate the virtual environment:
- Windows:venv\Scripts\activate
- Linux/macOS:source venv/bin/activate
Install dependencies:
Code Block pip install -r requirements.txt
Run the validator:
Code Block flask --app api run
Add the validator to
.env
:Code Block # DEGREE VALIDATOR VALIDATOR=<httphttp://localhost:50020>127.0.0.1:5000
For any unused variables in your
.env
file, just leave them blank.Generate
Prisma
client and run web server:
...