Skip to content

Commit 9574e19

Browse files
committed
Update the README
1 parent 6c8961f commit 9574e19

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,28 @@ Tools used for development:
3636

3737
### Running Balancer for development
3838

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/)
39+
Start the Postgres, Django REST, and React services by starting Docker Desktop and running `docker compose up --build`
4340

44-
Running pgAdmin:
41+
#### Postgres
42+
- Download a sample of papers to upload from [https://balancertestsite.com](https://balancertestsite.com/)
4543
- 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.
44+
- The first time you use `pgAdmin` after building the Docker containers you will need to register the server.
4745
The `Host name/address`, `Username` and `Password` are specified in `balancer-main/docker-compose.yml`
46+
- You can use the below code snippet to query the database from a Jupyter notebook:
47+
48+
```
49+
from sqlalchemy import create_engine
50+
import pandas as pd
51+
52+
engine = create_engine("postgresql+psycopg2://balancer:balancer@localhost:5433/balancer_dev")
53+
54+
query = "SELECT * FROM api_embeddings;"
55+
56+
df = pd.read_sql(query, engine)
57+
```
58+
59+
#### Django REST
60+
- The email and password are set in `server/api/management/commands/createsu.py`
4861

4962
## Architecture
5063

0 commit comments

Comments
 (0)