Réécrire le projet pour la v4 #4
1 changed files with 29 additions and 16 deletions
45
v4/README.md
45
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`
|
||||
|
|
Loading…
Reference in a new issue