From c1b8c39e92faa51cb23856016e9220ebce1775c0 Mon Sep 17 00:00:00 2001
From: Anthony Debucquoy <debucquoy.anthony@gmail.com>
Date: Mon, 22 Apr 2024 23:18:38 +0200
Subject: [PATCH] adding to readme
---
README.md | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 2d33f08..c957b55 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# Clyde project
+Système de gestion d'universitée (dévelopé dans le cadre du cours de projet de génie logiciel de l'Umons 2024)
+
## Signature
Projet du groupe 01:
@@ -11,21 +13,28 @@ Projet du groupe 01:
## Running
+**Attention**: Vous devez avoir installé docker-compose pour lancer ce projet.
+
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
+Dans le cas ou vous modifiez des fichiers, pour éviter que les images de docker ne soient réutilisés sans les
+changements.
```sh
$ docker compose up --force-recreate --build
```
+Vous pouvez alors accéder au frontend à l'adresse [http://localhost:5173](http://localhost:5173)
+
+Une version finie du site construite automatiquement à l'aide de gitea actions tourne à l'adresse
+[https://clyde.herisson.ovh/](https://clyde.herisson.ovh/)
## Dévelopement
-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.
+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.
**Attention**: Ce mode n'est pas fait pour être utilisé en production!
```sh
@@ -38,4 +47,3 @@ Ceci requière également docker pour lancer une instance de postgresql pris en
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)
-