Anri Kennel
8ade72e93a
update readme and rename file Co-authored-by: Mylloon <kennel.anri@tutanota.com> Reviewed-on: #72
68 lines
2.2 KiB
Markdown
68 lines
2.2 KiB
Markdown
# 🌱 Botanique [](https://ci.mylloon.fr/ConfrerieDuKassoulait/Botanique)
|
|
|
|
[**Ajoute le bot à ton serveur**](https://discord.com/api/oauth2/authorize?client_id=965598852407230494&permissions=8&scope=bot%20applications.commands)
|
|
|
|
## Lancer le bot
|
|
|
|
### En local
|
|
|
|
> Cloner le repo
|
|
|
|
> Spécifier un fichier `.env` en suivant [l'exemple](config/example.env)
|
|
|
|
> Installer les dépendances du bot
|
|
|
|
```bash
|
|
npm install --legacy-peer-deps
|
|
```
|
|
|
|
> Lancer le bot
|
|
|
|
```bash
|
|
npm run main
|
|
```
|
|
|
|
### Avec Docker (recommandé)
|
|
|
|
> Facile avec `docker-compose`
|
|
|
|
```docker
|
|
version: "3.9"
|
|
|
|
services:
|
|
botanique:
|
|
image: git.mylloon.fr/confreriedukassoulait/botanique:latest
|
|
container_name: Botanique
|
|
environment:
|
|
- TOKEN_DISCORD=ton-token-va-ici
|
|
volumes:
|
|
- /here/your/path:/config
|
|
restart: unless-stopped
|
|
```
|
|
|
|
## 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/) |
|
|
|
|
## Volumes
|
|
|
|
| Chemin | Description |
|
|
| :-------: | :-------------------------------------------------------------------------: |
|
|
| `/config` | Dossier de configuration, par exemple, c'est ici que la base de donnée est. |
|
|
|
|
# Contribuer
|
|
|
|
Toute contribution est la bienvenue !
|
|
|
|
Pour commencer, lis le [fichier de contribution](./CONTRIBUTING.md).
|
|
|
|
# Licence
|
|
|
|
Voir le [fichier LICENCE](./LICENCE).
|
|
|
|
# Crédits
|
|
|
|
[Photo de profil](https://picrew.me/image_maker/1497656)
|