Botanique/README.md

# 🌱 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épendences du bot.
```bash
npm install
```

> Lancer le bot.
```bash
npm run main
```

### 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
[Photo de profil](https://picrew.me/image_maker/1497656)