- Python 3.8 ou supérieur
- pip (Python package manager)
- Un navigateur web moderne (Chrome, Firefox, Safari, Edge)
- Retrouver la liste des bibliothèques utilisées dans la section Bibliothèques utilisées ci-dessous
- Ouvrir un terminal de commande (sur Windows, préferer l'invite de commande à PowerShell)
- Naviguer jusqu'au dossier
source/api/de ce projet - Exécuter la commande suivante, une seule fois, pour installer l'application et ses dépendances :
Note : le script batch/shell est à exécuter obligatoirement depuis le répertoire source/api/ et ne doit pas être exécuté depuis un autre emplacement !!!
Windows
# From source/api/ directory
scripts\setupmacOS/Linux
# From source/api/ directory
./scripts/setup.shLe script d'installation crée un environnement virtuel Python, installe les dépendances listées dans requirements.txt, et prépare la base de données SQLite pour l'application.
- Toujours depuis le terminal de commande, dans le dossier
source/api/, exécuter la commande suivante pour lancer l'api :
Windows
# From source/api/ directory
scripts\startmacOS/Linux
# From source/api/ directory
./scripts/start.sh # macOS/LinuxL'api sera disponible à http://localhost:5000 (mode développement). Vérifier http://localhost:5000/health pour s'assurer que l'api est bien lancée.
La page web source/web/index.html doit ensuite être ouverte dans un navigateur.
Vous pouvez aussi accéder à la version hébergée sur GitHub Pages : https://llg-mapper.github.io/. Cette page nécessite tout de même le lancement en local de l'api, qui doit resté live pendant l'utilisation de l'interface.
disponible dans requirements.txt
alembic==1.17.2
blinker==1.9.0
click==8.3.1
colorama==0.4.6
dotenv==0.9.9
Flask==3.1.2
flask-cors==6.0.2
Flask-Migrate==4.1.0
Flask-SQLAlchemy==3.1.1
greenlet==3.3.0
itsdangerous==2.2.0
Jinja2==3.1.6
Mako==1.3.10
MarkupSafe==3.0.3
marshmallow==3.21.3
marshmallow-sqlalchemy==1.0.0
marshmallow-enum==1.5.1
python-dotenv==1.2.1
SQLAlchemy==2.0.45
typing_extensions==4.15.0
Werkzeug==3.1.4
gunicorn==25.0.3