Crypto FR Summer Camp - Guess the word !

Devinez les expressions cryptos qui se cachent derrière les images.
Signaler un bug · Demander une nouvelle fonctionnalité

Qu'est ce que le projet "Guess the word !" ?

"Guess the word !" fait partie des projets développés lors du Summer Camp Crypto FR 2023. Le projet est développé par la communauté Crypto FR.

(Retour en haut)

Démarrer

Voici les instructions à suivre pour démarrer le projet en local.

Les technos utilisées

Le projet est développé en Javascript avec un serveur NODE.JS et la bibliothèque discord.js.

(retour en haut)

Prerequisites

Voici les élémens à avoir en local avant de démarrer :

• npm
• Node.js
• Avoir une clée d'API de bot Discord

Installation

1. Cloner le repo

   git clone https://github.com/Samolower/summer-camp-discord-bot-guess-the-word.git

2. Se déplacer dans le répertoire du projet

   
   cd summer-camp-discord-bot-guess-the-word

3. Installation des dépendences

   npm install

4. Renomer le .env.sample en `.env``

   mv .env.sample .env

5. Modifier la clé d'api du bot dans le .env

   BOT_TOKEN="Insert your bot token"

(retour en haut)

Utilisation

1. Créez 3 channels sur votre discord :

   1. Ladder : Ou le classement des uitlisateurs sera affiché et mis à jour automatiquement par le bot.
   2. Guess : Ou les admins pourront lancer de nouveaux mots avec /guess.
   3. Game : Ou les utilisateurs cherche le mot. Le bot validera automatiquement les réponses.

2. Créer les variables d'environnement dans le fichier .env :

   mv .env-sample .env

   Avec :

   BOT_TOKEN="Insert your bot token"
   CHAN_ID_NEW_WORD="Where images are added using /guess"
   CHAN_ID_LADDER="Where ladder is displayed"
   CHAN_ID_GAME="Where members can try to find the word"

3. Inviter le bot sur son discord et lui positionner les droits Admin.

4. Lancer le bot :

   1. En local:

      node main.js

   2. Via Docker :

      docker compose up

(retour en haut)

Roadmap

Allez sur open issues afin de suivre la liste des évolutions en cours.

(retour en haut)

Contribuer

Le projet est open source et toutes les contributions sont les bienvenues.

Afin de contribuer, voici la marche à suivre :

1. Créer un compte Github
2. Fork le projet
3. Créer sa branche de fonctionnalité (git checkout -b feature/AmazingFeature)
4. Commit les changements (git commit -m 'Add some AmazingFeature')
5. Push les changements (git push origin feature/AmazingFeature)
6. Faire une Pull Request sur Github.

Pour que vos modifications soient acceptées, elles doivent :

• Avoir un commentaire sur chaque commit. En anglais.
• Le code doit être clair et commenté.
• La branche de votre projet doit suivre feature/feature_name

(retour en haut)

Licence

Le projet est open source, distributé sous licence MIT. Voir LICENCE pour plus d'informations.

(retour en haut)

Contact

Discord : Discord

Twitter : @CryptoFR

Project Link : https://github.com/samolower/summer-camp-discord-bot-guess-the-word

(retour en haut)