23 lines
869 B
Markdown
23 lines
869 B
Markdown
# BreCal
|
|
|
|
## OpenAPI 3.0 Generated Flask project
|
|
|
|
The code was originally created by exporting the API from Postman. Selecting the API on the left (root element) the code generation icon becomes visible on the right.
|
|
|
|
|
|
|
|
If the API gets updated I think it makes most sense to export again into a API helper branch and then merge this branch back into the project. Please do not forget to update the [index.yaml](../../misc/index.yaml) file.
|
|
The branch is named yaml_export.
|
|
|
|
All the routes are defined in 'project/api' folder.
|
|
Each route parses the request and calls the corresponding function in the 'project/impl' directory passing all the parameters and request body as function arguments.
|
|
|
|
To run this project:
|
|
|
|
```bash
|
|
pip install -r requirements.txt
|
|
export FLASK_APP='BreCal'
|
|
export FLASK_ENV=development
|
|
flask run
|
|
```
|