chore(ci) (#72) [skip ci]

update readme and rename file

Co-authored-by: Mylloon <kennel.anri@tutanota.com>
Reviewed-on: #72
This commit is contained in:
Mylloon 2023-02-14 21:13:49 +01:00
parent 9935a56757
commit 8ade72e93a
2 changed files with 25 additions and 10 deletions

View file

@ -0,0 +1,14 @@
pipeline:
publish:
image: woodpeckerci/plugin-docker-buildx:2
settings:
platforms: linux/amd64
repo: git.mylloon.fr/${CI_REPO,,}
auto_tag: true
registry: git.mylloon.fr
username: ${CI_REPO_OWNER}
password:
from_secret: cb_token
when:
event: push
branch: main

View file

@ -6,31 +6,32 @@
### En local
> Cloner le repo.
> Cloner le repo
> Spécifier un fichier `.env` en suivant [l'exemple](config/example.env).
> Spécifier un fichier `.env` en suivant [l'exemple](config/example.env)
> Installer les dépendences du bot.
> Installer les dépendances du bot
```bash
npm install --legacy-peer-deps
```
> Lancer le bot.
> Lancer le bot
```bash
npm run main
```
### Avec Docker (Recommandé)
### Avec Docker (recommandé)
> Facile avec `docker-compose`
```docker
version: "3.9"
services:
botanique:
build: https://git.kennel.ml/ConfrerieDuKassoulait/Botanique.git#main
image: git.mylloon.fr/confreriedukassoulait/botanique:latest
container_name: Botanique
environment:
- TOKEN_DISCORD=ton-token-va-ici
@ -42,9 +43,9 @@ services:
## Variables d'environnements
| Nom | Description | Par défaut | Commentaire |
| :-----------: | :---------------: | :--------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| :-----------: | :---------------: | :--------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| TOKEN_DISCORD | Token Discord | Aucune |
| DEFAULT_LANG | Langue par défaut | `fr` | Expérimental, si la langue par défaut n'est pas complète (càd 100%), le bot pourrait ne pas fonctionner correctement.<br>Liste des traductions disponibles [ici](./src/locales/). |
| DEFAULT_LANG | Langue par défaut | `fr` | Expérimental, si la langue par défaut n'est pas complète (càd 100%), le bot pourrait ne pas fonctionner correctement.<br>Liste des traductions disponibles [ici](./src/locales/) |
## Volumes
@ -62,6 +63,6 @@ Pour commencer, lis le [fichier de contribution](./CONTRIBUTING.md).
Voir le [fichier LICENCE](./LICENCE).
# Références
# Crédits
[Photo de profil](https://picrew.me/image_maker/1497656)