Skip to content

Falcort/discord-bot-event

Repository files navigation

Discord bot event

Created by SOUQUET Thibault

Contributors by ROSAR Quentin & MARTINEZ Jennifer

Licence GitHub package.json version Github CI

Quality Gate Status Maintainability Rating Code Smells Bugs Coverage

Project under AGPLv3

Created in 2019

Subject

This discord bot was designed for the Star Citizen organisation Svalinn Tactical Security Group.
It is design to be able to store event on a particular date and time, so people can join the event.
The goal was to manage the number of people that have joined an event, and better organise the event with that number in mind.

It was initially written ine Javascript, and quickly moved into TypeScript.

How to use

This is NodeJS application that need a MongoDB database to store the events. You need to fill the config.json file with your information.

Then here are the available commands :

  • npm run build - This will compile the Typescript into javascript.
  • npm start:dev - This will start the Typescript application development purposes.
  • npm run start - This will start the application using the dist folder.
  • npm run lint - This will generate a ESLint report listing all the errors and warnings of code style/quality
  • npm run test - This will run jest unit tests (and collect coverage).

Sometimes the bot is unable to connect to the Discords servers, if so you can try this commands :
npm install https://github.com/woor/discord.io/tarball/gateway_v6

Warnings

  1. For some commands you will need to have environment variables set for them to work correctly
  2. The Github actions files requires some environment variables as well

Useful links