From 2e22603095dab6192045947887d94361ea08db72 Mon Sep 17 00:00:00 2001 From: Sahil D Shah Date: Tue, 1 Apr 2025 17:29:02 -0400 Subject: [PATCH 1/6] Update README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 2cb15f8d..42847a17 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,8 @@ Start Docker Desktop and run `docker compose up --build` 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 From 5b490c65947f56c38f0b11bccede3cfaa7c0de92 Mon Sep 17 00:00:00 2001 From: Sahil D Shah Date: Tue, 1 Apr 2025 17:30:29 -0400 Subject: [PATCH 2/6] Update README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 42847a17..0abdfba0 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,12 @@ 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: +Tools used for Balancer development: -1. `Docker and docker-compose` +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` +3. `Postman`: Ask to get invited to the Balancer Postman team `balancer_dev` +4. `pgAdmin`: The email and password are specified in `balancer-main/docker-compose.yml` ### Running Balancer for development From fa462618544bfc910ad11807ae71ec2ef7975f5d Mon Sep 17 00:00:00 2001 From: Sahil D Shah Date: Tue, 1 Apr 2025 17:33:43 -0400 Subject: [PATCH 3/6] Update README --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0abdfba0..c4ad4905 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,13 @@ 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 Balancer development: - +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. `Postman`: Ask to get invited to the Balancer Postman team `balancer_dev` -4. `pgAdmin`: The email and password are specified in `balancer-main/docker-compose.yml` + +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 From d4d319336604aef5773c5305c885adc1f092bf18 Mon Sep 17 00:00:00 2001 From: Sahil D Shah Date: Fri, 4 Apr 2025 13:39:41 -0400 Subject: [PATCH 4/6] Update README --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index c4ad4905..a20fa51d 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,9 @@ 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` +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` + ### Running Balancer for development Start Docker Desktop and run `docker compose up --build` From 34fc12db6115894720737f620528ad9430f287f1 Mon Sep 17 00:00:00 2001 From: Sahil D Shah Date: Fri, 4 Apr 2025 13:44:25 -0400 Subject: [PATCH 5/6] Update README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a20fa51d..2bf8a04b 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,13 @@ 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` -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` ### 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/) From fddc2f5e3bb76cc6e6212a7a2cdd9908c86499fe Mon Sep 17 00:00:00 2001 From: Sahil D Shah Date: Fri, 4 Apr 2025 14:00:04 -0400 Subject: [PATCH 6/6] Update README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 2bf8a04b..f8653782 100644 --- a/README.md +++ b/README.md @@ -50,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