changement readme

2026-05-20 11:18:09 +02:00
parent 05d60d5e55
commit e0b314ee76
2 changed files with 38 additions and 1 deletions
@@ -1 +1,34 @@
-# Api-DataSentinel
+# Api-DataSentinel
+
+API FastAPI pour Data Sentinel.
+
+## Installation
+
+1. Ouvrir un terminal dans le dossier du projet :
+   ```powershell
+   cd "c:\Users\antho\Desktop\Projet de fin d'année\Projet fin d_année\DataSentinel\Api-DataSentinel"
+   ```
+2. Créer et activer l'environnement virtuel (si nécessaire) :
+   ```powershell
+   python -m venv .venv
+   .\.venv\Scripts\Activate.ps1
+   ```
+3. Installer les dépendances :
+   ```powershell
+   pip install -r requirements.txt
+   ```
+
+## Lancement de l'API
+
+Utiliser la commande suivante pour démarrer le serveur :
+
+```powershell
+.\.venv\Scripts\python.exe -m uvicorn main:app --reload --port 8000
+```
+
+> Important : si le lanceur `\.venv\Scripts\uvicorn.exe` est cassé après un déplacement de dossier, utilisez toujours `python -m uvicorn`.
+
+## Vérification
+
+- Swagger : `http://127.0.0.1:8000/docs`
+- Santé : `http://127.0.0.1:8000/health`