heig-lherman/ddc-discord-bot

Délégué de classe

HEIG-VD - Délégué de classe Discord Bot

Docker

dacc4/heig-ddc-discord-bot on docker hub

Development

Prerequisites

• Node 16 with npm (latest)
• Redis sevrer
• Firebase app

Preparation of the environment

Install the dependencies with npm:

npm install

Copy the file .env.example, and complete the properties with the corresponding tokens:

cp .env.example .env

Running the bot

npm run dev

This command compiles the bot sources, then starts the bot (through src/bot.ts). If NODE_ENV == development, the HMR module is enabled, and commands, tasks, listeners, etc. will be automatically reloaded on compile.

Lint

We use ESLint and Prettier, with the airbnb config adapted to check Typescript source code.

# Running ESLint
npm run lint

# Run ESLint with auto-correction
npm run lint:fix

TypeScript type checking

npm run tsc:check

This command runs the TypeScript compiler with the --noEmit option. It validates types for the entire project.

Writing features

This bot uses the Sapphire Framework, features should follow the standard conventions from the framework.

ddc-discord-bot's Issues

fuzzy match rentsch quotes

faire que ça doit être moins de 80% similaire à une autre quote avant d'autoriser l'ajout.

commitizen + standard-version

homework module by channel id

abstract counter manager

calendrier des anniversaires

track lost time with rentsch-time

migrate to twitch ws eventsub

abstract quote manager

quote export

run-batch command

create discord events for homeworks and tests

1 week before test
2 days before homework

In same listener: send message with event link in class channel
In another listener: send reminder on day before

To think about: add a custom role for event notifications?

events: timezone offset when building iso date string

twitch notifs

create !time-remaining, such as to depress everyone

depends #9

returns the time until class ends 😭

collection based quotes

event title and description editing

create !test from homework to store test dates

fix docker env

use local config file for google firebase auth

create !schedule and match with !homework and !test for schedule

guild sub-collection: classes.
doc id: auto
doc contents: class name, start and end time, channel id

use different api in menu cron

https://apix.blacktree.io/top-chef/today

Only has the menu of the day. Useful for the cron.
Should always work as it is used by the intranet.

drop cooldown to please mister butty

menus don't work anymore

the good old blacktree api doesn't work anymore