Skip to content

[WIP] [#307] Update the README #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: listOfMed
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,28 @@ Tools used for development:

### Running Balancer for development

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

Running pgAdmin:
#### Postgres
- Download a sample of papers to upload from [https://balancertestsite.com](https://balancertestsite.com/)
- The email and password of `pgAdmin` 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 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`
- You can use the below code snippet to query the database from a Jupyter notebook:

```
from sqlalchemy import create_engine
import pandas as pd

engine = create_engine("postgresql+psycopg2://balancer:balancer@localhost:5433/balancer_dev")

query = "SELECT * FROM api_embeddings;"

df = pd.read_sql(query, engine)
```

#### Django REST
- The email and password are set in `server/api/management/commands/createsu.py`

## Architecture

Expand Down