From f49f203fe034afc42758b440974f929d2a2a268c Mon Sep 17 00:00:00 2001 From: Itay Shirizly Date: Sun, 4 Oct 2020 17:05:26 +0300 Subject: [PATCH] Added README.md for the server --- Server/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 Server/README.md diff --git a/Server/README.md b/Server/README.md new file mode 100644 index 0000000..98b7a7d --- /dev/null +++ b/Server/README.md @@ -0,0 +1,24 @@ +# zoom-attendance-check API + +API doc can be found [here](https://documenter.getpostman.com/view/4335694/TVRg694k) + +## Requirements +1. Install python 3 and pip +2. `pip install -r requirements.txt` +3. `python run.py` + +API will be running now at: `http://localhost:5000` + +## Project structure +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 endpoints +- `utils` - general utils for the application + +also there are: + +- `models.py` - ORM models for the database +- `config.py` - genreal settings for the application \ No newline at end of file