Commit 0336496f authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Updated the docs.

parent ea96289d
......@@ -4,40 +4,12 @@
## REST API Implementation
Folder structure:
~~~
.
|____app
| |______init__.py
| |____api_v1_0
| | |______init__.py
| | |____errors.py
| | |____routes.py
| |____config.py
| |____decorators
| | |______init__.py
| | |____caching.py
| | |____crossdomain.py
| | |____json.py
| | |____paginate.py
| |____mockup
| | |____mockup.py
| | |____README.md
| | |____requirements.txt
| |____models.py
| |____static
| |____templates
| |____utils.py
|____nomadapprun.py
|____README.md
|____requirements.txt
|____tests
| |______init__.py
~~~
This folder structure has two top-level folders:
- The Flask application lives inside a package generically named app.
- Unit tests are written in a tests package.
- [app/api_v1_0/routes.py](app/api_v1_0/routes.py) contains the actual API endpoint
implementations.
- [app/dmss.py](app/dmss.py) contains a dmss abstraction to access mongodb
- Unit tests are written in the [tests](tests) package.
There are also a few files:
- `requirements.txt` lists the package dependencies so that it is easy to regenerate an identical virtual environment on a different computer/server
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment