bottin/README.md

# agecem/bottin

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

Remplir .env avec les infos qui seront utilisées pour déployer le container

(Remplacer `bottin` par quelque chose de plus sécuritaire)

```sh
BOTTIN_API_KEY=bottin
BOTTIN_POSTGRES_DATABASE=bottin
BOTTIN_POSTGRES_PASSWORD=bottin
BOTTIN_POSTGRES_USER=bottin
BOTTIN_WEB_PASSWORD=bottin
BOTTIN_WEB_USER=bottin
```

Déployer avec docker-compose

`$ docker-compose up -d`

### Optionnel: configuration par fichiers YAML

*seulement nécessaire si les fichiers `.env` et `docker-compose.yaml` ne contiennent pas toute l'information nécessaire*

Pour modifier la configuration du serveur API

`$ docker-compose exec -it api vi /etc/bottin/api.yaml`

*Y remplir au minimum le champs `api.key` (string)*

Pour modifier la configuration du client web

`$ docker-compose exec -it web vi /etc/bottin/web.yaml`

*Y remplir au minimum les champs `web.api.key` (string), `web.user` (string) et `web.password` (string)*

Redémarrer les containers une fois la configuration modifiée

`$ docker-compose down && docker-compose up -d`
Retirer références à /v4 de README.md 2023-06-02 16:42:29 -04:00			`# agecem/bottin`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Retirer références à /v4 de README.md 2023-06-02 16:42:29 -04:00			`Bottin de la masse étudiante, en Go`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`https://git.agecem.com/agecem/bottin`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`## fonctionalités`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`### Serveur API`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`- Insertion de membre et programme`
			`- Lecture de membre`
			`- Modification du nom d'usage de membre`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`### Client web`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`- Lecture de membre par requête au serveur API`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`## usage`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`Remplir .env avec les infos qui seront utilisées pour déployer le container`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			(Remplacer `bottin` par quelque chose de plus sécuritaire)
Squashed into initial commit 2023-03-06 14:01:18 -05:00
			```sh
feat: Permettre de configurer `api` et `web` par `.env` L'ajout à viper de replacer et préfixe `BOTTIN` permet de déployer et configurer l'application avec seulement docker-compose, en évitant d'avoir à nécessairement uploader un fichier de config. Ajoute aussi des explications dans `README.md` sur changements de procédure 2024-02-14 14:05:04 -05:00			`BOTTIN_API_KEY=bottin`
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`BOTTIN_POSTGRES_DATABASE=bottin`
			`BOTTIN_POSTGRES_PASSWORD=bottin`
			`BOTTIN_POSTGRES_USER=bottin`
feat: Permettre de configurer `api` et `web` par `.env` L'ajout à viper de replacer et préfixe `BOTTIN` permet de déployer et configurer l'application avec seulement docker-compose, en évitant d'avoir à nécessairement uploader un fichier de config. Ajoute aussi des explications dans `README.md` sur changements de procédure 2024-02-14 14:05:04 -05:00			`BOTTIN_WEB_PASSWORD=bottin`
			`BOTTIN_WEB_USER=bottin`
Squashed into initial commit 2023-03-06 14:01:18 -05:00			```

Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`Déployer avec docker-compose`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`$ docker-compose up -d`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
feat: Permettre de configurer `api` et `web` par `.env` L'ajout à viper de replacer et préfixe `BOTTIN` permet de déployer et configurer l'application avec seulement docker-compose, en évitant d'avoir à nécessairement uploader un fichier de config. Ajoute aussi des explications dans `README.md` sur changements de procédure 2024-02-14 14:05:04 -05:00			`### Optionnel: configuration par fichiers YAML`

			seulement nécessaire si les fichiers `.env` et `docker-compose.yaml` ne contiennent pas toute l'information nécessaire

Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`Pour modifier la configuration du serveur API`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`$ docker-compose exec -it api vi /etc/bottin/api.yaml`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			Y remplir au minimum le champs `api.key` (string)
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`Pour modifier la configuration du client web`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`$ docker-compose exec -it web vi /etc/bottin/web.yaml`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			Y remplir au minimum les champs `web.api.key` (string), `web.user` (string) et `web.password` (string)
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`Redémarrer les containers une fois la configuration modifiée`
Squashed into initial commit 2023-03-06 14:01:18 -05:00
Bump root version to v4 Remove all files from v3 Move all files from v4/ to project root 2023-05-29 18:19:31 -04:00			`$ docker-compose down && docker-compose up -d`