README - Bot Discord Points pour The Hacking Project

📚 Présentation du Projet

Bienvenue dans le projet Bot Discord Points pour The Hacking Project. Ce bot permet de distribuer des points THP en récompense de l'implication des membres.

🚀 Technologies Utilisées

Voici un aperçu des principales technologies utilisées :

• Backend :

  • Node.js
  • Typescript

• Base de Données :

  • Utilisation de l'ORM Prisma

• Gestion de Version :

  • Git & GitHub - pour le contrôle de version et la collaboration

⚙️ Commandes d'Installation et de Lancement

Suivez ces étapes pour faire fonctionner le projet sur votre machine locale :

Prérequis

Assurez-vous d'avoir les éléments suivants installés :

• Node.js
• npm ou pnpm comme gestionnaire de paquets js
• Git
• Un éditeur de code comme VS Code

Installation

1. Cloner le repository :

• SSH :

  git clone git@github.com:discord-bot-points/Points-Discord.git

• HTTPS :

  git clone https://github.com/discord-bot-points/Points-Discord.git

2. Initialisation :

   cd Points-Discord

   npm i

   ou

   pnpm i

3. Créer le fichier .env :

   Créer un fichier .env qui reprend les variables du fichier .env.example en remplaçant les exemples par vos propres variables. La seed de base gère la création de 2 utilisateurs et 3 domaines. Si vous souhaitez en créer davantage, il vous suffit de copier les variables existantes dans le env.example et de rajouter les variables créées dans le config.ts.

4. Créer les migrations et lancer la seed pour créer votre base de données :

   npx prisma migrate dev

   ou

   pnpm dlx prisma migrate dev

   et ensuite

   pnpm run seed

5. Lancement du serveur :

   npm run dev

   ou

   pnpm run dev

Documentations des commandes :

• Help

• Balance

• Send

• Generate

• Leaderboard

• Public Leaderboard

Contributeurs :

Merci à tous ceux qui ont contribué à ce projet !

• Alexia Scherer
• Yann Rezigui
• Raphaël Marcarini
• Jeremie Olivier
• Malo Bastianelli
• Tommy Pellerin
• Sasha Godel