Skip to content

Martial59110/bot-discord-onboarding

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤖 Bot Discord d'Onboarding

Bot Discord développé en TypeScript pour gérer l'onboarding des nouveaux membres sur le serveur Discord de Simplon HdF.

📋 Description

Ce bot facilite l'intégration des nouveaux membres en automatisant plusieurs processus d'accueil et de configuration. Il interagit avec une API dédiée pour gérer les données des utilisateurs et leur progression dans le processus d'onboarding.

🛠️ Technologies Utilisées

✨ Fonctionnalités Principales

  • 👋 Accueil Automatisé

    • Message de bienvenue personnalisé
    • Attribution automatique des rôles de base
    • Guide des premières étapes
  • 📝 Gestion des Étapes d'Onboarding

    • Suivi de la progression
    • Validation des étapes
    • Rappels automatiques
  • 🔐 Gestion des Permissions

    • Attribution dynamique des accès
    • Vérification des rôles
    • Sécurisation des commandes
  • 🔄 Intégration API

    • Synchronisation avec l'API d'onboarding
    • Gestion des données utilisateurs
    • Suivi des statistiques

🚀 Démarrage du Projet

Prérequis

  • Node.js (version 16.x ou supérieure)
  • npm ou yarn
  • Un token de bot Discord
  • Les identifiants de l'API

Installation

  1. Cloner le repository

    git clone https://github.com/Simplon-hdf/bot-discord-onboarding.git
    cd bot-discord-onboarding
  2. Installer les dépendances

    npm install
  3. Configurer les variables d'environnement

    cp .env.example .env
    # Éditer .env avec vos informations
  4. Compiler le TypeScript

    npm run build
  5. Démarrer le bot

    • En développement :
      npm run dev
    • En production :
      npm start

📝 Logs

Le bot utilise Pino pour la gestion des logs avec différents niveaux :

  • ERROR : Erreurs critiques
  • WARN : Avertissements
  • INFO : Informations générales
  • DEBUG : Informations de débogage (uniquement en développement)

🤝 Contribution

Consultez CONTRIBUTING.md pour les règles de contribution.

📄 Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%