Skip to content

Commit

Permalink
Added README.md for the server
Browse files Browse the repository at this point in the history
  • Loading branch information
ItayS14 committed Oct 4, 2020
1 parent 28aaf94 commit f49f203
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions Server/README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit f49f203

Please sign in to comment.