You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-25Lines changed: 20 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,45 +17,40 @@ Join the [Code for Philly Slack and introduce yourself](https://codeforphilly.or
17
17
18
18
The project kanban board is [on GitHub here](https://github.com/orgs/CodeForPhilly/projects/2)
19
19
20
+
### Code for Philly Code of Conduct
21
+
22
+
The Code for Philly Code of Conduct is [here](https://codeforphilly.org/pages/code_of_conduct/)
23
+
20
24
### Setting up a development environment
21
25
22
26
Get the code using git by either forking or cloning `CodeForPhilly/balancer-main`
23
27
24
28
Tools used to run Balancer:
29
+
1.`OpenAI API`: Ask for an API key and add it to `config/env/env.dev`
30
+
2.`Anthropic API`: Ask for an API key and add it to `config/env/env.dev`
31
+
32
+
Tools used for development:
25
33
1.`Docker`: Install Docker Desktop
26
-
2.`OpenAI API`: Ask for the API key and add it to `config/env/env.dev`
27
-
3.`Anthropic API`: Ask for the API key and add it to `config/env/env.dev`
28
-
4.`pgAdmin`: The email and password are specified in `balancer-main/docker-compose.yml`
29
-
5.`Postman`: Ask to get invited to the Balancer Postman team `balancer_dev`
34
+
2.`Postman`: Ask to get invited to the Balancer Postman team `balancer_dev`
35
+
3.`npm`: In the terminal run 1) 'cd frontend' 2) 'npm install' 3) 'cd ..'
30
36
31
37
### Running Balancer for development
32
38
33
-
Clone the repos.
34
-
35
-
Open the project in VS Code.
36
-
37
-
In the terminal run 1) 'cd frontend' 2) 'npm install' 3) 'cd ..'
39
+
Running Balancer:
40
+
- Start Docker Desktop and run `docker compose up --build`
41
+
- The email and password are set in `server/api/management/commands/createsu.py`
42
+
- Download a sample of papers to upload from [https://balancertestsite.com](https://balancertestsite.com/)
38
43
39
-
Start Docker Desktop and run `docker compose up --build`
40
-
41
-
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`
42
-
43
-
The email and password are set in `server/api/management/commands/createsu.py`
44
-
45
-
Download a sample of papers to upload from [https://balancertestsite.com](https://balancertestsite.com/)
44
+
Running pgAdmin:
45
+
- The email and password of `pgAdmin` are specified in `balancer-main/docker-compose.yml`
46
+
- The first time you use `pgAdmin` after building the Docker containers you will need to register the server.
47
+
The `Host name/address`, `Username` and `Password` are specified in `balancer-main/docker-compose.yml`
46
48
47
49
## Architecture
48
50
49
-
The Balancer website is a Django, React, and Postgres project
50
-
51
-
### Source code layout
52
-
53
-
Important files and directories in `balancer-main/`:
51
+
The Balancer website is a Postgres, Django REST, and React project. The source code layout is:
54
52
55
-
-`docker-compose.yml`: Used to run docker compose
56
-
-`server`: Django backend
57
-
-`entrypoint.sh`: Migrations, Create superuser, Populate database on start up
0 commit comments