diff --git a/README.md b/README.md index 2cb15f8d..f8653782 100644 --- a/README.md +++ b/README.md @@ -21,19 +21,25 @@ The project kanban board is [on GitHub here](https://github.com/orgs/CodeForPhil Get the code using git by either forking or cloning `CodeForPhilly/balancer-main` -Tools used for for Balancer development: - -1. `Docker and docker-compose` +Tools used to run Balancer: +1. `Docker`: Install Docker Desktop 2. `OpenAI API`: Ask for the API key and add it to `config/env/env.dev` -3. `pgAdmin`: The email and password are specified in `balancer-main/docker-compose.yml` -4. `Postman`: Ask to get invited to the Balancer Postman team `balancer_dev` + +Tools used for Balancer development: +1. `Postman`: Ask to get invited to the Balancer Postman team `balancer_dev` +2. `pgAdmin`: The email and password are specified in `balancer-main/docker-compose.yml` + ### Running Balancer for development Start Docker Desktop and run `docker compose up --build` +The first time you use `pgAdmin` after building the Docker containers you will need to register the server. The `Host name/address`, `Username` and `Password` are specified in `balancer-main/docker-compose.yml` + The email and password are set in `server/api/management/commands/createsu.py` +Download a sample of papers to upload from [https://balancertestsite.com](https://balancertestsite.com/) + ## Architecture The Balancer website is a Django, React, and Postgres project @@ -44,6 +50,7 @@ Important files and directories in `balancer-main/`: - `docker-compose.yml`: Used to run docker compose - `server`: Django backend + - `entrypoint.sh`: Migrations, Create superuser, Populate database on start up - `frontend`: React frontend ## License