README.md

Lettres

Installation

Dans un répertoire local dédié au projet :

• Cloner le repository GitHub : git clone https://github.com/chartes/lettres-app.git

Dans le répertoire d'accueil de l'application :

• Exécuter les commandes :

python3 -m venv lettresenv
source lettresenv/bin/activate
pip install -r requirements.txt

• Se rendre dans le sous-répertoire contenant le fichier flask_app.py et le lancer : python3 flask_app.py
• Lancer une requête de contrôle : http:/yourhost/lettres/api/1.0/documents?page[size]=2 (ex: http://127.0.0.1:5004/lettres/api/1.0/documents?page[size]=2)

Indexation

Installer la version Elasticsearch conforme aux spécifications

Depuis le répertoire d'accueil de l'application, exécuter : python3 manage.py db-reindex --host=http://yourhost (ex: python3 manage.py db-reindex --host=http://localhost:5004)

Ajouter un utilisateur

Depuis le répertoire d'accueil de l'application, exécuter :

python3 manage.py add-user --email=myemail@email.fr --username=myusername --password=MySup3rPassw0rd!

Ajouter le flag --admin pour ajouter les droits d'admin au compte crée

Documentation :

• Documentation de l'API

Lancer le front-end

• Voir Readme du Front-end