History

H4CK3R-01 4bfcbded0b Merge remote-tracking branch 'origin/main'		2022-04-04 14:10:45 +02:00
..
app	Try to fix database problems	2022-04-04 14:10:25 +02:00
deploy	Extracted frontend from webservice to new directory	2022-03-17 17:11:00 +01:00
tests	Refactoring	2022-03-30 11:10:48 +02:00
.env.example	Update .env.example	2022-04-04 13:30:04 +02:00
app.py	Tests	2022-03-30 10:46:54 +02:00
Dockerfile	Extracted frontend from webservice to new directory	2022-03-17 17:11:00 +01:00
README.md	Update README.md	2022-03-30 10:51:38 +02:00
requirements.txt	Update flask requirement from ~=2.1.0 to ~=2.1.1 in /api	2022-03-31 10:32:06 +00:00

README.md

API

Aktienbot API

Development

Create virtual environment python -m venv venv env/Scripts/activate
Install requirements pip install -r api/requirements.txt
Set environment variables (see list below)
1. Use .env-file in api directory like .env.example
2. Or set variables using export or set commands. (Windows set, Linux export)
Run api python api/app.py

Testing

Create virtual environment python -m venv venv env/Scripts/activate
Install requirements pip install -r api/requirements.txt
Set environment variables (see list below)
1. Use .env-file in api directory like .env.example
2. Or set variables using export or set commands. (Windows set, Linux export)
Change directory: cd api/
Run tests: python -m pytest -v --cov-report term-missing --cov=app

Environment variables

    # Flask secret key
    SECRET_KEY=
    
    # MYSQL Connection
    MYSQL_USER=
    MYSQL_PASSWORD=
    MYSQL_HOST=
    MYSQL_PORT=
    MYSQL_DATABASE=

Docker

docker run -d \
    --name aktienbot_api \
    --hostname aktienbot_api \
    --publish 80:80 \
    --env "SECRET_KEY=" \
    --env "MYSQL_USER=" \
    --env "MYSQL_PASSWORD=" \
    --env "MYSQL_HOST=" \
    --env "MYSQL_PORT=" \
    --env "MYSQL_DATABASE=" \
    --restart unless-stopped \
    registry.flokaiser.com/aktienbot/api:latest

or load environment variables from file by using --env-file <filename>