Skip to content
This repository has been archived by the owner on Dec 26, 2018. It is now read-only.

Latest commit

 

History

History
26 lines (14 loc) · 1.77 KB

README.md

File metadata and controls

26 lines (14 loc) · 1.77 KB

EvoDoc / Back End

Build Status codecov

This is backend api for Evodoc app.

Minimal requirements

Our app need database, you can either use sqlite or postgresql, both should do the job. Tests are however performed on sqlite by default.

How to run APP

First you have to setup configuration, in /conf you will find example of local configuration.

In development use flask run, after installation everything from requirements.txt. After that you have to define, where flask can find evodoc as application using this export FLASK_APP=relative/path/to/evodoc/folder/wsgi.py, then you should also type export FLASK_ENV=dev (this enables dev enviroment). After this you should be able to run app just by typing flask run.

On your production just use gunicorn or other wsgi utility. Application uses app_factory, so for your application use evodoc.wsgi:app, ie. (gunicorn -b 127.0.0.1:5000 evodoc.wsgi:app). To build project just run python3 setup.py build. Minimal requirements for this app are: sqlite or postgresql as your database, Python3.5+. For your local configurations head to the ./conf and create file appseting.local.ini using example in the same folder. This file has to be then copied to your build or installation folder. Also you have to copy while migrations folder as it is to your build or installation folder.

Tests

We are using pytest for our unit and itegration tests, tests can be executed using python3 -m pytest.

Documentation

For code documentation we are using sphinx, for api link to api doc