From 7887be18385a8de3b880b20bf138bdf669abbf78 Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Thu, 25 May 2023 23:29:54 -0400 Subject: [PATCH] =?UTF-8?q?Mettre=20=C3=A0=20jour=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v4/README.md | 45 +++++++++++++++++++++++++++++---------------- 1 file changed, 29 insertions(+), 16 deletions(-) diff --git a/v4/README.md b/v4/README.md index 77ca460..c32ebe5 100644 --- a/v4/README.md +++ b/v4/README.md @@ -1,13 +1,24 @@ +# agecem/bottin/v4 + +Version 4 du bottin de la masse étudiante, en Go + +https://git.agecem.com/agecem/bottin + +## fonctionalités + +### Serveur API + +- Insertion de membre et programme +- Lecture de membre +- Modification du nom d'usage de membre + +### Client web + +- Lecture de membre par requête au serveur API + ## usage -### Base de données - -`docker-compose.yaml` est fourni pour facilité le développement avec une base de données postgres sur docker. - -En production, des efforts de high-availability devraient être mis. - - -Remplir .env avec les infos qui seront utilisées pour déployer le container: +Remplir .env avec les infos qui seront utilisées pour déployer le container (Remplacer `bottin` par quelque chose de plus sécuritaire) @@ -17,20 +28,22 @@ BOTTIN_POSTGRES_PASSWORD=bottin BOTTIN_POSTGRES_USER=bottin ``` -Déployer avec docker-compose: +Déployer avec docker-compose `$ docker-compose up -d` -### Configuration +Pour modifier la configuration du serveur API -Remplir le fichier de config `~/.bottin.yaml`. +`$ docker-compose exec -it api vi /etc/bottin/api.yaml` -## Build +*Y remplir au minimum le champs `api.key` (string)* -Build l'exécutable du serveur. (TODO) +Pour modifier la configuration du client web -### API +`$ docker-compose exec -it web vi /etc/bottin/web.yaml` -Démarrer le serveur web: +*Y remplir au minimum les champs `web.api.key` (string), `web.user` (string) et `web.password` (string)* -`$ bottin server` +Redémarrer les containers une fois la configuration modifiée + +`$ docker-compose down && docker-compose up -d`