Readme

README.md

+# LQDN RP
+
+This project uses Django 1.11 and python >= 3.5
+
+## Requirements
+
+To run the project, start a virtual environment and install
+requirements.txt requirements-dev.txt contains additional dependencies
+for development
+
+    $ pip install -r requirements.txt
+    $ pip install -r requirements-dev.txt
+
+## Settings
+
+Create a file in `project/settings/env.py` which contains django
+settings for **DEBUG** and **SECRET_KEY**.
+
+For testing you can use `DEBUG = True` and a random string for
+`SECRET_KEY`.
+
+In production you can use env variables with
+
+```python
+os.environ["DJANGO_DEBUG"]
+os.environ["DJANGO_SECRET_KEY"]
+```
+
+## Database
+
+You can run migrations with :
+
+    $ python manage.py migrate
+
+## Dev server
+
+To launch the dev server :
+
+    $ python manage.py runserver
+
+## Tests
+
+To launch tests install requirements-tests.txt
+
+    $ pip install -r requirements-tests.txt
+    $ pytest
+
+Coverage with
+
+    $ pytest --cov=.