bottin/v4/README.md

37 lines
690 B
Markdown
Raw Normal View History

2023-05-25 01:21:09 -05:00
## 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:
(Remplacer `bottin` par quelque chose de plus sécuritaire)
```sh
BOTTIN_POSTGRES_DATABASE=bottin
BOTTIN_POSTGRES_PASSWORD=bottin
BOTTIN_POSTGRES_USER=bottin
```
Déployer avec docker-compose:
`$ docker-compose up -d`
### Configuration
Remplir le fichier de config `~/.bottin.yaml`.
## Build
Build l'exécutable du serveur. (TODO)
### API
Démarrer le serveur web:
`$ bottin server`