Ce bot Discord français et Open-Source vous permet de trouver les espèces de fourmi qui essaiment dans votre département.
- Cloner ce repository
- Installez les dépendances avec
npm install - Créez un fichier
.envà la racine de votre projet avec les informations suivantes:
#.env
TOKEN=//le_token_de_votre_bot_discord//
CLIENT_ID=//uuid_de_votre_client_discord//- Compilez les fichiers TypeScript en Javascript avec la commande
npx tsc, l'option --watch permet de lancer la compilation en démon. - Lancez le bot avec
npm run start
Vous pouvez générez la documentation avec npm run doc.
Vous pouvez lancer les tests unitaires avec npm run test.
- Discord.js - La librairie pour interagir avec l'API Discord
- Node.js - L'environnement d'exécution JavaScript
- TypeScript - Le langage de programmation utilisé
- dotenv - Pour gérer les variables d'environnement
- jest - Pour les tests unitaires
- typeDoc - Pour générer la documentation du code
- node-schedule - Pour planifier la création des backups des données
Les contributions au code seront analysées, n'hésitez pas à faire des pull requests (vers dev) si vous avez la moindre suggestion ou fix de bugs. Vous pouvez aussi ajouter des informations aux datas concernant les dates d'essaimages.
Merci à :
Ce projet est sous la licence MIT License - regardez le fichier LICENSE pour plus de détails.