From 19ed58f579b5fbf7ef10a3afd4c3b36692370957 Mon Sep 17 00:00:00 2001 From: mco-system Date: Sun, 23 Apr 2023 18:51:48 +1100 Subject: [PATCH] toto --- README.md | 39 +++++++++++++++++++++++++++++++++++---- 1 file changed, 35 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5c4e5c7..b111dac 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,46 @@ # THSF.NET -Le site du THSF +Le site du **THSF** -## Modifier le site +## Fonctionnement du site + +Le site du **THSF** est une application *Python Flask* configurée à partir du fichier `config.yml` situé à la racine du dépôt. + +Il n'est généralement pas nécessaire de modifier ce fichier de configuration, cependant il ets possible d'augmenter le niveau de *log* en modifiant la clef de configuration `log::root::level` en la passant à `DEBUG` (valeur en production: `INFO`). + +### Conteneur + +Un fichier `thsf.Dockerfile` ainsi que le fichier `docker-compose.yml` correspondant permettront de rapidement démarrer localement une instance du site du **THSF**. + +### Démarrer une instance du site du **THSF** + +Assurez vous d'avoir l'environnement de conteneurisation adéquat (i.e: *docker* + *docker-compose*) puis exécuter directement les commandes suivantes depuis la racine du dépôt: + +```shell +docker-compose build +docker-compose up -d +``` + +Le site du **THSF** écoutera alors sur le port *TCP/8042*: + +`http://127.0.0.1:8042` + +### Arrêter une instance du site du **THSF** + +```shell +docker-compose down +``` + +## Apporter des modifications au site + +Le code de l'application *Python Flask* se situe dans le répertoire `src`. + +## Publication du site Il n'est **pas possible** de pousser directement des modifications sur la branche `master`. Pour modifier le site, il est nécessaire de créer une branche spécifique et d'y pousser vos modifications. -## Publication du site - Lorsque vous êtes satisfaits de vos modifications, vous pouvez créer [une demande d'ajout](https://git.tetalab.org/tetalab/thsf.net/pulls) de votre branche sur la branche `master`. Lorsque la demande de fusion sera acceptée, vos modifications seront automatiquement publiées sur [le site du THSF](https://www.thsf.net).