From ed6d853f222fd43961380331cf2dbc0c1400e98e Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 22:53:58 -0400 Subject: [PATCH 01/13] =?UTF-8?q?docs:=20WIP=20sur=20r=C3=A9=C3=A9criture?= =?UTF-8?q?=20de=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.2.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.2.md diff --git a/README.2.md b/README.2.md new file mode 100644 index 0000000..1d3e3f6 --- /dev/null +++ b/README.2.md @@ -0,0 +1,13 @@ +

+ agecem/agecem-org
agecem-org +

+ +Le site web officiel de l'Association Générale Étudiante du Cégep Édouard-Montpetit (AGECEM) + +Fondée en 1976, l’Association Étudiante est un organisme sans but lucratif voué à la défense des étudiant·e·s inscrit·e·s à l’enseignement régulier du Campus de Longueuil du Cégep Édouard-Montpetit, qu’iels étudient de jour ou de soir, à temps plein ou à temps partiel. Forte d’environ 6000 membres, elle veille à promouvoir un milieu pédagogique sain en se consacrant à les représenter, tant au niveau académique, politique, social, qu’environnemental. + +Le backend du site utilise Go avec [labstack/echo](https://github.com/labstack/echo) comme routeur de requêtes. + +Le frontend du site utilise HTML et CSS, avec une utilisation minimale de JavaScript. + +Le dévelopement et déploiement se fait par un fichier `Makefile`. From 0b4880d4b5b9578a708efb86398fba543f28f9eb Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 22:58:06 -0400 Subject: [PATCH 02/13] docs(readme): essais de fix le logo --- README.2.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.2.md b/README.2.md index 1d3e3f6..51345e9 100644 --- a/README.2.md +++ b/README.2.md @@ -1,5 +1,9 @@

- agecem/agecem-org
agecem-org + + agecem/agecem-org + agecem/agecem-org + haul +
agecem-org

Le site web officiel de l'Association Générale Étudiante du Cégep Édouard-Montpetit (AGECEM) From a13c1adf6b9c9190328843087e2bd91009ef4dad Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 23:00:06 -0400 Subject: [PATCH 03/13] docs(readme): essais de plus de fix le logo also retirer haul logo --- README.2.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.2.md b/README.2.md index 51345e9..32f2661 100644 --- a/README.2.md +++ b/README.2.md @@ -1,8 +1,7 @@

- agecem/agecem-org - agecem/agecem-org - haul + agecem/agecem-org + agecem/agecem-org
agecem-org

From 1726c0703c4c989afabacefcea289f6a49a35170 Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 23:01:28 -0400 Subject: [PATCH 04/13] docs(readme): consolider et aggrandir logo --- README.2.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.2.md b/README.2.md index 32f2661..8ef3fb5 100644 --- a/README.2.md +++ b/README.2.md @@ -1,7 +1,6 @@

- agecem/agecem-org - agecem/agecem-org + agecem/agecem-org
agecem-org

From f3dd1f30e980f90e3d9a9fa1c486b710a1501647 Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 23:04:14 -0400 Subject: [PATCH 05/13] docs(readme): highlighter le fait que l'application est un site web --- README.2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.2.md b/README.2.md index 8ef3fb5..d810ba8 100644 --- a/README.2.md +++ b/README.2.md @@ -4,7 +4,7 @@
agecem-org -Le site web officiel de l'Association Générale Étudiante du Cégep Édouard-Montpetit (AGECEM) +Le **site web officiel** de l'Association Générale Étudiante du Cégep Édouard-Montpetit (AGECEM) Fondée en 1976, l’Association Étudiante est un organisme sans but lucratif voué à la défense des étudiant·e·s inscrit·e·s à l’enseignement régulier du Campus de Longueuil du Cégep Édouard-Montpetit, qu’iels étudient de jour ou de soir, à temps plein ou à temps partiel. Forte d’environ 6000 membres, elle veille à promouvoir un milieu pédagogique sain en se consacrant à les représenter, tant au niveau académique, politique, social, qu’environnemental. From 3ae537d03c3bc31c64ab64a6c70760e87b30f3dc Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 23:12:56 -0400 Subject: [PATCH 06/13] =?UTF-8?q?docs(readme):=20ajouter=20titres=20de=20s?= =?UTF-8?q?ections=20et=20section=20pr=C3=A9requis?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.2.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.2.md b/README.2.md index d810ba8..85f5954 100644 --- a/README.2.md +++ b/README.2.md @@ -6,10 +6,27 @@ Le **site web officiel** de l'Association Générale Étudiante du Cégep Édouard-Montpetit (AGECEM) -Fondée en 1976, l’Association Étudiante est un organisme sans but lucratif voué à la défense des étudiant·e·s inscrit·e·s à l’enseignement régulier du Campus de Longueuil du Cégep Édouard-Montpetit, qu’iels étudient de jour ou de soir, à temps plein ou à temps partiel. Forte d’environ 6000 membres, elle veille à promouvoir un milieu pédagogique sain en se consacrant à les représenter, tant au niveau académique, politique, social, qu’environnemental. +## Description + +*Fondée en 1976, l’Association Étudiante est un organisme sans but lucratif voué à la défense des étudiant·e·s inscrit·e·s à l’enseignement régulier du Campus de Longueuil du Cégep Édouard-Montpetit, qu’iels étudient de jour ou de soir, à temps plein ou à temps partiel. Forte d’environ 6000 membres, elle veille à promouvoir un milieu pédagogique sain en se consacrant à les représenter, tant au niveau académique, politique, social, qu’environnemental.* Le backend du site utilise Go avec [labstack/echo](https://github.com/labstack/echo) comme routeur de requêtes. Le frontend du site utilise HTML et CSS, avec une utilisation minimale de JavaScript. -Le dévelopement et déploiement se fait par un fichier `Makefile`. + +## Prérequis + +Pour profiter des pipelines définis dans le fichier `Makefile`: + +- [make](https://www.gnu.org/software/make/) + +Pour déployer le projet localement par containers: + +- [docker](https://www.docs.docker.com/) +- [docker-compose](https://docs.docker.com/compose/) + +Pour déployer une version allégée (sans base de données ou docker): + +- [go](https://go.dev/) + From 6a93cfdff7d8d9e2e2bc27050470f2bd334c0044 Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 23:34:02 -0400 Subject: [PATCH 07/13] docs(readme): ajouter plusieurs quickstarts --- README.2.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 51 insertions(+), 3 deletions(-) diff --git a/README.2.md b/README.2.md index 85f5954..08d9ba7 100644 --- a/README.2.md +++ b/README.2.md @@ -17,16 +17,64 @@ Le frontend du site utilise HTML et CSS, avec une utilisation minimale de JavaSc ## Prérequis -Pour profiter des pipelines définis dans le fichier `Makefile`: +GNU Make est recommandé pour profiter des pipelines définis dans le fichier `Makefile`: - [make](https://www.gnu.org/software/make/) +Pour déployer une version allégée (sans base de données ou docker): + +- [go](https://go.dev/) + Pour déployer le projet localement par containers: - [docker](https://www.docs.docker.com/) - [docker-compose](https://docs.docker.com/compose/) -Pour déployer une version allégée (sans base de données ou docker): +Pour déployer sur kubernetes: -- [go](https://go.dev/) +- [kubectl](https://kubernetes.io/docs/tasks/tools/) +*note: L'installation de docker, docker-compose, make, go, kubectl n'est pas couverte par ce projet et doit être effectuée en se référant à la documentation de votre système d'exploitation.* + +## Démarrage rapide + +### Localement en version allégée + +Avec [go](https://go.dev/) installé et fonctionnel, exécuter: + +`make go-run` + +Cela démarrera un serveur web `agecem/agecem-org`, qui peut être configuré au préalable avec le fichier `$HOME/.agecem-org.yaml`. + +*note: le serveur [minio](https://min.io/) requis pour la documentation n'est pas démarré avec cette option, et ne peut donc pas être testé en détails. Par contre, le contenu statique et les thèmes devraient être bien appliqués, ce qui rend cette option idéale pour du développement rapide et léger ne nécessitant pas accès à la documentation.* + +### Localement avec docker-compose + +Pour déployer une version complète, locale, et isolée, `docker-compose` est l'option la plus simple. + +Il est nécessaire de premièrement créer un fichier `.env` contenant le minimum de configuration; les credentials pour minio: + +``` +# .env +MINIO_ROOT_USER=agecem-org +MINIO_ROOT_PASSWORD=agecem-org +``` + +Ensuite, avec [docker](https://www.docs.docker.com/) et [docker-compose](https://docs.docker.com/compose/) installés et fonctionnels, exécuter: + +`make docker-build docker-deploy` + +Cela démarrera 2 containers: + +- un serveur web `agecem/agecem-org` +- un serveur [minio](https://min.io/) + +*note: La configuration peut être modifiée, voir les volumes déclarés dans le fichier `compose.yaml` pour le named volume de configuration du serveur.* + +TODO + +## Pipelines avancés + +### Build et push image vers le repo officiel + +`make docker-build docker-tag-from-git docker-push-from-git` From a2ddcf871505a5b7f61d5dfeb6af9016ec8f9c72 Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 23:35:49 -0400 Subject: [PATCH 08/13] =?UTF-8?q?docs(readme):=20sp=C3=A9cifier=20que=20le?= =?UTF-8?q?=20repo=20est=20du=20code=20source?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.2.md b/README.2.md index 08d9ba7..181d310 100644 --- a/README.2.md +++ b/README.2.md @@ -4,7 +4,7 @@
agecem-org -Le **site web officiel** de l'Association Générale Étudiante du Cégep Édouard-Montpetit (AGECEM) +Code source du site web officiel de l'Association Générale Étudiante du Cégep Édouard-Montpetit (AGECEM) ## Description From 6ece5e3c093a5588c94f674ea32f35c8ba29e150 Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 23:45:04 -0400 Subject: [PATCH 09/13] =?UTF-8?q?docs(readme):=20importer=20proc=C3=A9dure?= =?UTF-8?q?=20locale=20all=C3=A9g=C3=A9e=20depuis=20README.md=20pr=C3=A9c?= =?UTF-8?q?=C3=A9dent.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.2.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.2.md b/README.2.md index 181d310..1a35c16 100644 --- a/README.2.md +++ b/README.2.md @@ -40,9 +40,21 @@ Pour déployer sur kubernetes: ### Localement en version allégée +Pour un environnement simplifié sans minio ou docker, seul le toolchain `go` devrait être nécessaire au démarrage du serveur. + Avec [go](https://go.dev/) installé et fonctionnel, exécuter: -`make go-run` +`$ go run ./cmd/agecemorg/ server` + +Si nécessaire, un fichier de config peut être déposé dans `$HOME/.agecem-org.yaml` ou spécifié tel que: + +`$ go run ./cmd/agecemorg/ server --config agecem-org.yaml` + +où `agecem-org.yaml` doit être remplacé par l'emplacement du fichier de config désiré. + +Pour un exemple de fichier de config en format JSON, voir le résultat de: + +`go run ./cmd/agecemorg/ config` Cela démarrera un serveur web `agecem/agecem-org`, qui peut être configuré au préalable avec le fichier `$HOME/.agecem-org.yaml`. @@ -71,8 +83,6 @@ Cela démarrera 2 containers: *note: La configuration peut être modifiée, voir les volumes déclarés dans le fichier `compose.yaml` pour le named volume de configuration du serveur.* -TODO - ## Pipelines avancés ### Build et push image vers le repo officiel From 13ebd1183c3cc9a7479517e02f031ecda0bdbd42 Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 23:51:06 -0400 Subject: [PATCH 10/13] docs(readme): standardiser commandes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Ajouter notice critique de nécessité de changer le mdp minio en production. Ajouter commandes de base de `docker-compose`. --- README.2.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.2.md b/README.2.md index 1a35c16..73219ca 100644 --- a/README.2.md +++ b/README.2.md @@ -44,11 +44,11 @@ Pour un environnement simplifié sans minio ou docker, seul le toolchain `go` de Avec [go](https://go.dev/) installé et fonctionnel, exécuter: -`$ go run ./cmd/agecemorg/ server` +`go run ./cmd/agecemorg/ server` Si nécessaire, un fichier de config peut être déposé dans `$HOME/.agecem-org.yaml` ou spécifié tel que: -`$ go run ./cmd/agecemorg/ server --config agecem-org.yaml` +`go run ./cmd/agecemorg/ server --config agecem-org.yaml` où `agecem-org.yaml` doit être remplacé par l'emplacement du fichier de config désiré. @@ -72,6 +72,8 @@ MINIO_ROOT_USER=agecem-org MINIO_ROOT_PASSWORD=agecem-org ``` +**important: en production, il est critique de changer ces valeurs!** + Ensuite, avec [docker](https://www.docs.docker.com/) et [docker-compose](https://docs.docker.com/compose/) installés et fonctionnels, exécuter: `make docker-build docker-deploy` @@ -83,6 +85,18 @@ Cela démarrera 2 containers: *note: La configuration peut être modifiée, voir les volumes déclarés dans le fichier `compose.yaml` pour le named volume de configuration du serveur.* +Pour voir l'état des containers: + +`docker-compose ps` + +Pour voir les logs des containers: + +`docker-compose logs` + +Pour détruire les containers déployés localement: + +`docker-compose down` + ## Pipelines avancés ### Build et push image vers le repo officiel From c9ab4716926a95d3d026f991ac9e07694bfa153d Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 23:53:08 -0400 Subject: [PATCH 11/13] =?UTF-8?q?docs(readme):=20=C3=A9craser=20README.md?= =?UTF-8?q?=20avec=20contenu=20de=20README.2.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.2.md | 104 ---------------------------------------------------- README.md | 102 +++++++++++++++++++++++++++++++++++---------------- 2 files changed, 71 insertions(+), 135 deletions(-) delete mode 100644 README.2.md diff --git a/README.2.md b/README.2.md deleted file mode 100644 index 73219ca..0000000 --- a/README.2.md +++ /dev/null @@ -1,104 +0,0 @@ -

- - agecem/agecem-org -
agecem-org -

- -Code source du site web officiel de l'Association Générale Étudiante du Cégep Édouard-Montpetit (AGECEM) - -## Description - -*Fondée en 1976, l’Association Étudiante est un organisme sans but lucratif voué à la défense des étudiant·e·s inscrit·e·s à l’enseignement régulier du Campus de Longueuil du Cégep Édouard-Montpetit, qu’iels étudient de jour ou de soir, à temps plein ou à temps partiel. Forte d’environ 6000 membres, elle veille à promouvoir un milieu pédagogique sain en se consacrant à les représenter, tant au niveau académique, politique, social, qu’environnemental.* - -Le backend du site utilise Go avec [labstack/echo](https://github.com/labstack/echo) comme routeur de requêtes. - -Le frontend du site utilise HTML et CSS, avec une utilisation minimale de JavaScript. - - -## Prérequis - -GNU Make est recommandé pour profiter des pipelines définis dans le fichier `Makefile`: - -- [make](https://www.gnu.org/software/make/) - -Pour déployer une version allégée (sans base de données ou docker): - -- [go](https://go.dev/) - -Pour déployer le projet localement par containers: - -- [docker](https://www.docs.docker.com/) -- [docker-compose](https://docs.docker.com/compose/) - -Pour déployer sur kubernetes: - -- [kubectl](https://kubernetes.io/docs/tasks/tools/) - -*note: L'installation de docker, docker-compose, make, go, kubectl n'est pas couverte par ce projet et doit être effectuée en se référant à la documentation de votre système d'exploitation.* - -## Démarrage rapide - -### Localement en version allégée - -Pour un environnement simplifié sans minio ou docker, seul le toolchain `go` devrait être nécessaire au démarrage du serveur. - -Avec [go](https://go.dev/) installé et fonctionnel, exécuter: - -`go run ./cmd/agecemorg/ server` - -Si nécessaire, un fichier de config peut être déposé dans `$HOME/.agecem-org.yaml` ou spécifié tel que: - -`go run ./cmd/agecemorg/ server --config agecem-org.yaml` - -où `agecem-org.yaml` doit être remplacé par l'emplacement du fichier de config désiré. - -Pour un exemple de fichier de config en format JSON, voir le résultat de: - -`go run ./cmd/agecemorg/ config` - -Cela démarrera un serveur web `agecem/agecem-org`, qui peut être configuré au préalable avec le fichier `$HOME/.agecem-org.yaml`. - -*note: le serveur [minio](https://min.io/) requis pour la documentation n'est pas démarré avec cette option, et ne peut donc pas être testé en détails. Par contre, le contenu statique et les thèmes devraient être bien appliqués, ce qui rend cette option idéale pour du développement rapide et léger ne nécessitant pas accès à la documentation.* - -### Localement avec docker-compose - -Pour déployer une version complète, locale, et isolée, `docker-compose` est l'option la plus simple. - -Il est nécessaire de premièrement créer un fichier `.env` contenant le minimum de configuration; les credentials pour minio: - -``` -# .env -MINIO_ROOT_USER=agecem-org -MINIO_ROOT_PASSWORD=agecem-org -``` - -**important: en production, il est critique de changer ces valeurs!** - -Ensuite, avec [docker](https://www.docs.docker.com/) et [docker-compose](https://docs.docker.com/compose/) installés et fonctionnels, exécuter: - -`make docker-build docker-deploy` - -Cela démarrera 2 containers: - -- un serveur web `agecem/agecem-org` -- un serveur [minio](https://min.io/) - -*note: La configuration peut être modifiée, voir les volumes déclarés dans le fichier `compose.yaml` pour le named volume de configuration du serveur.* - -Pour voir l'état des containers: - -`docker-compose ps` - -Pour voir les logs des containers: - -`docker-compose logs` - -Pour détruire les containers déployés localement: - -`docker-compose down` - -## Pipelines avancés - -### Build et push image vers le repo officiel - -`make docker-build docker-tag-from-git docker-push-from-git` diff --git a/README.md b/README.md index a1e19c9..73219ca 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,70 @@ -# agecem/agecem-org +

+ + agecem/agecem-org +
agecem-org +

-Site web de l'AGECEM. +Code source du site web officiel de l'Association Générale Étudiante du Cégep Édouard-Montpetit (AGECEM) + +## Description + +*Fondée en 1976, l’Association Étudiante est un organisme sans but lucratif voué à la défense des étudiant·e·s inscrit·e·s à l’enseignement régulier du Campus de Longueuil du Cégep Édouard-Montpetit, qu’iels étudient de jour ou de soir, à temps plein ou à temps partiel. Forte d’environ 6000 membres, elle veille à promouvoir un milieu pédagogique sain en se consacrant à les représenter, tant au niveau académique, politique, social, qu’environnemental.* + +Le backend du site utilise Go avec [labstack/echo](https://github.com/labstack/echo) comme routeur de requêtes. + +Le frontend du site utilise HTML et CSS, avec une utilisation minimale de JavaScript. -Le backend utilise [go-echo](https://echo.labstack.com/). ## Prérequis -- `docker` -- `docker-compose` +GNU Make est recommandé pour profiter des pipelines définis dans le fichier `Makefile`: -L'installation de `docker` et `docker-compose` est hors de la portée de ce projet. Veuillez vous référer à la documentation de votre système d'exploitation. +- [make](https://www.gnu.org/software/make/) -## Procédure +Pour déployer une version allégée (sans base de données ou docker): -Le lifecycle du serveur est maintenu par containers, en utilisant `docker-compose`. +- [go](https://go.dev/) -### Exemples d'utilisation de docker-compose +Pour déployer le projet localement par containers: -*L'exemple suivant assume que minio est déployé par docker-compose en même temps que le serveur web.* +- [docker](https://www.docs.docker.com/) +- [docker-compose](https://docs.docker.com/compose/) -Remplir .env avec les credentials que minio utilisera pour sa configuration initiale. +Pour déployer sur kubernetes: -Remplacer `agecem-org` par quelque chose de sécurisé. +- [kubectl](https://kubernetes.io/docs/tasks/tools/) + +*note: L'installation de docker, docker-compose, make, go, kubectl n'est pas couverte par ce projet et doit être effectuée en se référant à la documentation de votre système d'exploitation.* + +## Démarrage rapide + +### Localement en version allégée + +Pour un environnement simplifié sans minio ou docker, seul le toolchain `go` devrait être nécessaire au démarrage du serveur. + +Avec [go](https://go.dev/) installé et fonctionnel, exécuter: + +`go run ./cmd/agecemorg/ server` + +Si nécessaire, un fichier de config peut être déposé dans `$HOME/.agecem-org.yaml` ou spécifié tel que: + +`go run ./cmd/agecemorg/ server --config agecem-org.yaml` + +où `agecem-org.yaml` doit être remplacé par l'emplacement du fichier de config désiré. + +Pour un exemple de fichier de config en format JSON, voir le résultat de: + +`go run ./cmd/agecemorg/ config` + +Cela démarrera un serveur web `agecem/agecem-org`, qui peut être configuré au préalable avec le fichier `$HOME/.agecem-org.yaml`. + +*note: le serveur [minio](https://min.io/) requis pour la documentation n'est pas démarré avec cette option, et ne peut donc pas être testé en détails. Par contre, le contenu statique et les thèmes devraient être bien appliqués, ce qui rend cette option idéale pour du développement rapide et léger ne nécessitant pas accès à la documentation.* + +### Localement avec docker-compose + +Pour déployer une version complète, locale, et isolée, `docker-compose` est l'option la plus simple. + +Il est nécessaire de premièrement créer un fichier `.env` contenant le minimum de configuration; les credentials pour minio: ``` # .env @@ -29,36 +72,33 @@ MINIO_ROOT_USER=agecem-org MINIO_ROOT_PASSWORD=agecem-org ``` -Déployer le ou les containers en mode détaché, en s'assurant de rebâtir l'image. +**important: en production, il est critique de changer ces valeurs!** -`$ docker-compose up -d --build` +Ensuite, avec [docker](https://www.docs.docker.com/) et [docker-compose](https://docs.docker.com/compose/) installés et fonctionnels, exécuter: -Voir l'état des containers +`make docker-build docker-deploy` -`$ docker-compose ps` +Cela démarrera 2 containers: -Voir les logs des containers +- un serveur web `agecem/agecem-org` +- un serveur [minio](https://min.io/) -`$ docker-compose logs` +*note: La configuration peut être modifiée, voir les volumes déclarés dans le fichier `compose.yaml` pour le named volume de configuration du serveur.* -Détruire les containers +Pour voir l'état des containers: -`$ docker-compose down` +`docker-compose ps` -### Exemple de développement sans base de données ou docker +Pour voir les logs des containers: -Pour un environnement simplifié sans minio ou docker, seul le toolchain `go` devrait être nécessaire au démarrage du serveur. +`docker-compose logs` -Pour une exécution sans installation permanente, veuillez utiliser: +Pour détruire les containers déployés localement: -`$ go run ./cmd/agecemorg/ server` +`docker-compose down` -Si nécessaire, un fichier de config peut être déposé dans `$HOME/.agecem-org.yaml` ou spécifié tel que: +## Pipelines avancés -`$ go run ./cmd/agecemorg/ server --config agecem-org.yaml` +### Build et push image vers le repo officiel -où `agecem-org.yaml` doit être remplacé par le fichier de config désiré. - -Pour un exemple de fichier de config en format JSON, voir le résultat de: - -`go run ./cmd/agecemorg/ config` +`make docker-build docker-tag-from-git docker-push-from-git` From 9d2fb4248d8db562cfb8f90e898137acc4505c58 Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sat, 12 Jul 2025 23:57:48 -0400 Subject: [PATCH 12/13] docs(readme): ajouter section contact --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 73219ca..92aa04a 100644 --- a/README.md +++ b/README.md @@ -102,3 +102,11 @@ Pour détruire les containers déployés localement: ### Build et push image vers le repo officiel `make docker-build docker-tag-from-git docker-push-from-git` + +## Contact + +Pour toute question ou assistance concernant l'Association Générale Étudiante du Cégep Édouard-Montpetit (AGECEM): + +- Adresse physique: Local B-31, 945 Chemin de Chambly, Longueuil, QC J4H 3M6 +- Téléphone: (450) 679-7375 +- Courriel: From 19a659583bfe8f1866138e9ac7e0c8d7b53c839f Mon Sep 17 00:00:00 2001 From: Victor Lacasse-Beaudoin Date: Sun, 13 Jul 2025 00:00:03 -0400 Subject: [PATCH 13/13] docs(readme): ajouter notice de license --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 92aa04a..2c37242 100644 --- a/README.md +++ b/README.md @@ -110,3 +110,7 @@ Pour toute question ou assistance concernant l'Association Générale Étudiante - Adresse physique: Local B-31, 945 Chemin de Chambly, Longueuil, QC J4H 3M6 - Téléphone: (450) 679-7375 - Courriel: + +## License + +Ce projet est distribué sous les termes de la [GNU General Public License, version 2](https://opensource.org/licenses/gpl-2-0/).