From 2e2837fec4a5b3905f8967bdb2ba1a5366e38b6d Mon Sep 17 00:00:00 2001
From: Anthony Debucquoy <debucquoy.anthony@gmail.com>
Date: Sat, 30 Mar 2024 23:33:16 +0100
Subject: [PATCH] adding info about compose

---
 README.md | 29 ++++++++++++++++++++++++++---
 1 file changed, 26 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 5a99ac9..2d33f08 100644
--- a/README.md
+++ b/README.md
@@ -9,10 +9,33 @@ Projet du groupe 01:
 - William Karpinski: Extension gestion des horaires
 - Léo Moulin: Extension inscription des étudiants
 
+## Running
+
+Le projet peut être lancé grace à docker compose.
+
+```sh
+$ docker compose up 
+```
+
+Dans le cas ou vous modifiers des fichiers, pour éviter que les images de docker soient recrées avec les changement
+
+```sh
+$ docker compose up --force-recreate --build
+```
+
 ## Dévelopement
 
-```
-$ ./gradlew backend:run frontend:run --parallel
-```
+Dans le cas ou vous êtes dans une phase de développement, il est plus simple d'utiliser gradle pour lancer le backend et frontend dans un mode de développement.
+**Attention**: Ce mode n'est pas fait pour être utilisé en production!
 
+```sh
+$ ./gradlew run --parallel
+```
 permet de lancer le frontend sur [http://localhost:5173](http://localhost:5173) ansi que le frontend sur [http://localhost:8080](http://localhost:8080) 
+
+Ceci requière également docker pour lancer une instance de postgresql pris en charge par spring.
+
+Il est possible de se passer entièrement de docker en supprimant la dépendance dans le fichier `backend/build.gradle.kts`: ~~`developmentOnly("org.springframework.boot:spring-boot-docker-compose")`~~
+Il est alors nécéssaire d'avoir une instance de postgresql tournant sur `localhost:5432` avec une table `clyde`, utilisateur: `devel` et password: `devel`
+(cette configuration peut également être changée dans le fichier resources/application.properties de spring)
+