mirror of
https://gitlab.atilla.org/atilla/JeSuis307.git
synced 2026-06-03 15:52:05 +02:00
No description
- TypeScript 99.9%
- Dockerfile 0.1%
| documentation | ||
| src | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| biome.json | ||
| Dockerfile | ||
| index.ts | ||
| options.ts | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
JeSuis307 (v2.1)
Repo officiel du botTILLA.
Installation et test en local
- Clonez le repo sur votre PC :
git clone https://gitlab.atilla.org/atilla/JeSuis307(HTTPS) ougit clone git@gitlab.atilla.org:atilla/JeSuis307.git(SSH) - Assurez vous d'avoir Node.js d'installé (v22.6 ou plus)
- Pour vérifier votre version de Node :
node -v
- Pour vérifier votre version de Node :
- Installez une base de donnée SQL localement sur votre PC (de préférence MySQL)
- À la racine du repo, créez un fichier
.envqui contiendra les variables d'environnement dont le bot a besoin. Référez-vous à la section sur les variables d'environnement pour plus d'informations.- Ajoutez la ligne
ATILLA_BOT_TOKEN=le_token_du_bot_testé(Demandez au devs le token du bot de test) - Ajoutez la ligne
ATILLA_BOT_DATABASE_URI=uri_de_votre_bdd. Si vous utilisez MySQL par exemple, ce sera :ATILLA_BOT_DATABASE_URI=mysql://username:password@localhost:3306/le_nom_de_ma_bdd - Ajoutez la ligne
ATILLA_BOT_TESTING=TRUEpour vous assurer d'être en mode de test.
- Ajoutez la ligne
- Assurez-vous que toutes les dépendances soient installées :
npm install - Lancez le bot :
npm start
Documentation
Manuel
La documentation des classes et des différents concepts à connaitre pour programmer sur le bot se trouve ici.
Coding Guidelines
La documentation sur les coding guidelines se trouve ici.
Variables d'environnement
Les variables d'environnement sont utilisées pour passer des options ou des credentials au bot. La liste des variables d'environnement peut être trouvée ici :
| Nom | Requis ? | Valeur par défaut | Description |
|---|---|---|---|
| ATILLA_BOT_TOKEN | ✔️ | Aucune | Le token Discord du bot. |
| ATILLA_BOT_DATABASE_URI | ✔️ | Aucune | L'uri utilisée pour se connecter à la bdd. |
| ATILLA_BOT_TESTING | ❌ | FALSE | Un booléen pour déterminer si le bot est en mode de test ou non. |
| ATILLA_BOT_LOGGER | ❌ | Console | Le nom du type de logger à utiliser pendant la durée de vie de l'application. |
| ATILLA_BOT_DISPLAY_COMMAND_TABLE | ❌ | FALSE | Si à 'TRUE', affiche la table des commandes dans les logs au démarrage de l'application. |
| ATILLA_BOT_DEVELOPER_IDS | ❌ | Aucune | Une liste d'ids Discord de développeurs. La liste est séparée par des virgules. Cette liste permet d'outrepasser les checks de permission des commandes en mode de test. |
| ATILLA_BOT_RESTART_TIME | ❌ | 10000 | La durée (en ms) de redémarrage du bot. Le bot redémarre uniquement via une commande manuelle. |
Auteurs/Contributeurs
- CORBEAU Maxime
- MORAU Josselin
- MOUSSET Martin
- MALZAC Guillaume
- HEURION Thomas
- CESSON Maxime
- DIZIN Jordan
- RETEL Gaétan