Merge pull request #8 from Chartes-TNAH/correction

Correction

.flaskenv

@@ -0,0 +1,6 @@
+FLASK_APP="dts_app.app:config_app('dev')"
+
+# fichier qui permet de faire le run de l'app c'est le chemin qu'on appelle quand on lance
+# FLASK_DEBUG=True flask run
+# quand on lance la commande FLASK avec la libraire dotenv permet de faire apparaitre les config qui sont dans
+# .env et .flaskenv et ça évite de relancer manuellement à chauqe fois les config quand on lance _app

.gitignore

@@ -1,3 +1,9 @@
+# IDE
+.idea/
+
+# SQLITE
+dev.sqlite
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -1,11 +1,38 @@
 DTS-Demo-Server
+===============
+
+# Run
+
+- `FLASK_DEBUG=True flask run` to run the API
+
+
+# Navigation example
+
+Load example by running `flask db load example_data.tsv` you can then navigate to 
+collection/endpoint
+navigation/endpoint
+and
+document/endpoint
+
+
+This server supports all parameters from http://w3id.org/dts except the pagination ones. 
+1. http://127.0.0.1:5000/
+2. http://127.0.0.1:5000/collection?id=/chants_contre
+3. [http://127.0.0.1:5000/collection?id=https://www.wikidata.org/wiki/Q3227832](http://127.0.0.1:5000/collection?id=https://www.wikidata.org/wiki/Q3227832)
+4. [http://127.0.0.1:5000/navigation?id=https://www.wikidata.org/wiki/Q3227832](http://127.0.0.1:5000/navigation?id=https://www.wikidata.org/wiki/Q3227832)
+5. [http://127.0.0.1:5000/document?id=https://www.wikidata.org/wiki/Q3227832&start=1&end=10](http://127.0.0.1:5000/document?id=https://www.wikidata.org/wiki/Q3227832&start=1&end=10)
+
+# Older Readme
+
 
 Présentation du projet :
 
 "DTS-Demo-Server" est une API issue (comme son nom l'indique) de DTS, qui vise 
 à rendre accessible et interrogeable une base de données composée de chants.
 Ce projet est développé avec Python3 dans le cadre du Master 2 TNAH de l'Ecole des Chartes.
 
+
+
 Pour l'installation en local des librairies correspondantes, il vous sera nécessaire de taper la commande suivante dans votre terminal :
 pip install -r requirements.txt