Botanique/README.md

68 lines
2 KiB
Markdown
Raw Normal View History

# 🌱 Botanique
2022-04-18 15:28:24 +02:00
[**Ajoute le bot à ton serveur**](https://discord.com/api/oauth2/authorize?client_id=965598852407230494&permissions=8&scope=bot%20applications.commands)
2022-04-18 18:54:59 +02:00
2022-06-06 11:30:25 +02:00
## Lancer le bot
2022-06-06 11:30:25 +02:00
### En local
2022-06-06 11:30:25 +02:00
> Cloner le repo.
> Spécifier un fichier `.env` en suivant [l'exemple](config/example.env).
2022-06-06 11:30:25 +02:00
> Installer les dépendences du bot.
2022-06-06 11:30:25 +02:00
```bash
npm install --legacy-peer-deps
2022-06-06 11:30:25 +02:00
```
> Lancer le bot.
2022-06-06 11:30:25 +02:00
```bash
npm run main
```
2022-04-18 18:54:59 +02:00
### Avec Docker (Recommandé)
> Facile avec `docker-compose`
```docker
version: "3.9"
services:
botanique:
build: https://git.kennel.ml/ConfrerieDuKassoulait/Botanique.git#main
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).
# Références
2022-04-18 18:54:59 +02:00
[Photo de profil](https://picrew.me/image_maker/1497656)