Home

Getting Started

Running the application

1. Make sure to have the latest version of docker installed and running properly on your computer.
2. Go into the project directory
3. Run git submodule init and git submodule update
4. Run docker compose up -d (-d runs the container in detached mode, so in the background)
   Congrats you are running the application.
   Go to localhost:3000 to view the the front-end
   localhost:5000 is the API endpoint
   localhost:5433 is the Database

Setting up development environment (Not required to run the application)

1. Install nodejs 20.15.1 LTS
2. Install python 3.11 or later
3. Go into the project directory
4. Run cd ./client && npm install
5. Run cd ../api && pip install pipenv
6. Run pipenv install