Skip to content

Latest commit

 

History

History
58 lines (33 loc) · 2.07 KB

README.md

File metadata and controls

58 lines (33 loc) · 2.07 KB

Balancer

Balancer is a website of digital tools designed to help prescribers choose the most suitable medications for patients with bipolar disorder, helping them shorten their journey to stability and well-being

Usage

You can view the current build of the website here: https://balancertestsite.com

Contributing

Join the Balancer community

Balancer is a Code for Philly project

Join the Code for Philly Slack and introduce yourself in the #balancer channel

The project kanban board is on GitHub here

Setting up a development environment

Get the code using git by either forking or cloning CodeForPhilly/balancer-main

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

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

Architecture

The Balancer website is a Django, React, and Postgres project

Source code layout

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

Balancer is licensed under the AGPL-3.0 license