Reformatting
This commit is contained in:
@@ -3,24 +3,26 @@
|
||||
Aktienbot API
|
||||
|
||||
## Development
|
||||
|
||||
1. Create virtual environment `python -m venv venv env/Scripts/activate`
|
||||
2. Install requirements `pip install -r api/requirements.txt`
|
||||
3. 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`)
|
||||
4. Run api `python api/app.py`
|
||||
|
||||
1. Use `.env`-file in `api` directory like `.env.example`
|
||||
2. Or set variables using `export` or `set` commands. (Windows `set`, Linux `export`)
|
||||
4. Run api `python api/app.py`
|
||||
|
||||
## Testing
|
||||
|
||||
1. Create virtual environment `python -m venv venv env/Scripts/activate`
|
||||
2. Install requirements `pip install -r api/requirements.txt`
|
||||
3. 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`)
|
||||
1. Use `.env`-file in `api` directory like `.env.example`
|
||||
2. Or set variables using `export` or `set` commands. (Windows `set`, Linux `export`)
|
||||
4. Change directory: `cd api/`
|
||||
5. Run tests: `python -m pytest -v --cov-report term-missing --cov=app`
|
||||
|
||||
## Environment variables
|
||||
|
||||
```
|
||||
# Flask secret key
|
||||
SECRET_KEY=
|
||||
@@ -34,6 +36,7 @@ Aktienbot API
|
||||
```
|
||||
|
||||
## Docker
|
||||
|
||||
```
|
||||
docker run -d \
|
||||
--name aktienbot_api \
|
||||
@@ -48,4 +51,5 @@ docker run -d \
|
||||
--restart unless-stopped \
|
||||
registry.flokaiser.com/aktienbot/api:latest
|
||||
```
|
||||
|
||||
or load environment variables from file by using `--env-file <filename>`
|
Reference in New Issue
Block a user