API doc can be found here
- Install python 3 and pip
pip install -r requirements.txt
python run.py
API will be running now at: http://localhost:5000
The server code is inside server package, and can be runned with the external module run.py
.
We decided to use flask-restful
extenstion in order to create the endpoints, and flaks-sqlalchemy
in order to create the database.
The inside the server
package is organzied into the following sub-packages:
api
- package which is responsible for the api endpointsutils
- general utils for the application
also there are:
models.py
- ORM models for the databaseconfig.py
- genreal settings for the application