Setup Guide for Running Locally

Prerequisites

• Python
• Node.js & npm
• PostgreSQL

See the prerequisites page for detailed instructions.

Steps

Frontend Setup

Install dependencies in the frontend folder:

cd frontend
npm install

Create the PostgreSQL database

psql -U postgres

Then, in the PostgreSQL prompt, run:

CREATE DATABASE db;

Backend Setup

In root directory a create virtual environment and activate it.

py -m venv env
env\Scripts\activate

Install backend dependencies:

pip install -r requirements.txt

Navigate to the backend folder:

cd backend

Apply migrations:

py manage.py migrate

Seed initial data:

py manage.py seed_data

Running the project

Starting the frontend (in one terminal).

npm run dev

Starting the backend (in another terminal).

py manage.py runserver