Cleaning & README

This commit is contained in:
Barnab 2024-03-27 17:30:48 +01:00
parent 6833cba08b
commit 1e32571702
10 changed files with 33 additions and 0 deletions

Binary file not shown.

View file

@ -0,0 +1,31 @@
# Guide utilisateur
## Solutions techniques
## Démarrage rapide
Un docker-compose est fourni à titre d'exemple. Il permet de rapidement déployer le système dadministration des JO Paris 2024.
Vous pouvez utiliser la commande suivante :
```bash
curl -o docker-compose.yml https://git.gnous.eu/Anrab35/SAE410_TP2/raw/branch/main/docker-compose.yml
docker compose up -d
```
Vous devez avoir les services suivants de lancés :
```txt
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
119dbbc12392 git.gnous.eu/anrab35/sae410_medals:latest "python3 medals.py" 22 minutes ago Up 22 minutes (healthy) 5000/tcp JO_medals
67d8e945bc8e git.gnous.eu/anrab35/sae410_athletes:latest "python3 athletes.py" 22 minutes ago Up 22 minutes (healthy) 5000/tcp JO_athletes
393a2e73ab59 git.gnous.eu/anrab35/sae410_docs:latest "python3 docs.py" 22 minutes ago Up 22 minutes 5000/tcp JO_docs
d7b5d3455cb4 git.gnous.eu/anrab35/sae410_sports:latest "python3 sports.py" 22 minutes ago Up 22 minutes (healthy) 5000/tcp JO_sports
05225e266ec6 traefik:v2.11 "/entrypoint.sh --lo…" 22 minutes ago Up 22 minutes 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:8080->8080/tcp, :::8080->8080/tcp traefik
```
## Utilisation de la suite de tests
Pour utiliser les tests unitaires, il faut commencer par cloner le dépôt et installer les dépendances :
```bash
git clone https://git.gnous.eu/Anrab35/SAE410_TP2.git
cd SAE410_TP2/pytest
python3 -m pip install -r requirements.txt
python3 -m pytest -v
```

2
pytest/requirements.txt Normal file
View file

@ -0,0 +1,2 @@
pytest==6.2.5
requests==2.28.1