helpwave

This is a first aid app for people in need of help. In an emergency, this app makes it possible to inform qualified helpers in the surrounding area and thus arrive at the scene of the emergency even faster than an ambulance.

Development

python venv setup

git clone https://github.com/Just-another-Muensterhack/helpwave-backend.git helpwave
python -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip
pip install -r app/requirements.txt

Database Setup

Change the Directory into the root project folder and start the postgres database with docker-compose.

docker-compose up -d postgres

Setup environment

Environment files: .api.env, .postgres.env

Console

Set the environment variables

set -a
. .api.env
. .postgres.env
set +a

Additionally, run the following commands if you are in dev mode.

export POSTGRES_HOST=localhost
unset SECRET_KEY_FILE

PyCharm / Intellij

1. Open 'Edit Run/Debug configurations' dialog (on the top right)
2. Edit configuration
3. Environment variables add following string: POSTGRES_HOST=localhost;POSTGRES_USER=postgres;POSTGRES_PASSWORD=S3cr3T;POSTGRES_NAME=api;POSTGRES_DB=api;POSTGRES_DB=api
4. apply configs

Run Project

python3 ./app/main.py

Model migrations [alembic]

Running our first migration (docs)

cd app && alembic upgrade head

Auto generating migration (docs)

cd app && alembic revision --autogenerate -m "<your message>"

MORE DOCS

Hacks

Linter

python -m black ./app/ --exclude --check --line-length 120

Postgres

restart plain postgres container

docker-compose down postgres

sudo rm -rf /srv/postgres/postgres-data

docker-compose up -d postgres