This repo contains the REST api that will be connected to several apps i'm working on
This REST api is used to handle a local transport management app.
For a deep description of the API, read the examples
file to see the tables involved and how they work; Read also the representation
file to see a beautiful representation of those tables(use neovim on full screen).
- Clone this repo
- cd into
rest-api
- create a virtual environment by writing
python -m venv .venv
- activate the virtual environment
source .venv/bin/activate
(for Windows, check the corresponding command) - install the requirements by
python -m pip install -r requirements.txt
- run the api by writing
python api.py
Docs will be released soon
Use the development
branch to track the latest changes, the main
branch is stable.