Skip to content

Latest commit

 

History

History
91 lines (70 loc) · 2.9 KB

README.md

File metadata and controls

91 lines (70 loc) · 2.9 KB

Logo botAgenda

Le bot Discord tout-en-un de gestion des devoirs, créé par et à destination des étudiants de l'IUT Informatique de Bordeaux


📦 Installation

Étape 1 : Cloner le dépôt Gitlab du projet

git clone https://gitlab.com/hubday/bot-agenda

Étape 2: Installer les dépendances projet à l'aide du gestionnaire de dépendances npm

cd bot-agenda/
npm install

Après cette étape, l'installation est terminée, mais il reste à configurer le projet. Tout est expliqué dans la section suivante.


⚙️ Configuration

Avant de pouvoir lancer le projet et l'essayer, il est nécessaire de saisir plusieurs variables d'environnement dans un fichier de configuration env.local.

Options disponibles

  • RTDB_URL (String, requis): URL de connexion à la base de données Firebase Realtime Database, sans '/' à la fin.
  • RTDB_AUTH_TOKEN (String, requis): Jeton d'authentification de la base de données.
  • DISCORD_BOT_TOKEN (String, requis): Jeton d'authentification du bot Discord.
  • DISCORD_BUG_REPORT_WEBHOOK_URL (String, facultatif): Le lien d'un webhook discord permettant de recevoir les messages de bug report.
  • DISCORD_ERRORS_REPORT_WEBHOOK_URL (String, facultatif): Le lien d'un webhook discord permettant de recevoir les messages d'erreur.

Exemple de fichier de configuration env.local:

RTDB_URL="https://{firebase-project-name}.firebaseio.com"
RTDB_AUTH_TOKEN="XXXXxXxXxXXXXXxXXXxxxXXXXxXXXXXXxxxxxxX"
DISCORD_BOT_TOKEN="XXXxXxXxXXXxXxXxXxXxXXXx.XXxxXX.XxxXXxX-XXXXxxxXxXxXxXxxxxx"
DISCORD_BUG_REPORT_WEBHOOK_URL="https://discordapp.com/api/webhooks/XXXXXX..."
DISCORD_ERRORS_REPORT_WEBHOOK_URL="https://discordapp.com/api/webhooks/XXXXXX..."

Une fois ce fichier de configuration créé et configuré, vous êtes prêt à tester le bot !

D'autres options de coniguration sont aussi disponibles dans le fichier src/config.ts


🛠 Commandes disponibles

  • Grand public :

[MP] !agenda-help affiche l'aide du bot

  • Développeurs :

[MP] !agenda-version affiche la version du bot

[MP] !agenda-logs envois le fichier contenant toutes les logs du bot


🚀 Lancement du projet

Vous êtes enfin prêt! Pour démarrer le projet, il vous suffit de démarrer le bot avec la commande suivante :

npm start

Pour lancer les tests unitaires du bot :

npm test


👥 Contributeurs


🖼️ Captures d'écran

À venir