A lightweight discord bot that functions as a ordering and queue system
We informatics students at UiB are very fond of both waffles and programming, which is why we decided to combine them. Every thursday students can come to our reading hall and receive free waffles and some guidance from our student oracles. This often resulted in long lines of people waiting to receive their waffles, and long waiting times. During the COVID-19 pandemic this became impossible to do, as 50 people cramped in a small room is a big no-no. That is why one week, we oracles decided to throw together this discord bot that could take orders digitally. This way people could still get their waffles, but without the whole 50 people in one room part. Though this was meant as a temporary solution, it now appears that the Waffle-bot is here to stay. Because of this we have decided to revamp the structure of this repo, and allow for any students that wish, to contribute to the project.
! If you want to contribute, you will need to fork the repository so that you can create pull requests to the main branch with your changes!
Before anything can be done you first have to create your .env file. Take a look at the .env.example file and replace the placeholder items with the relevant information. Take a look at this guide to set up a discord bot, and enter your token in your .env file.
Before you start development we suggest that you install some Javascript-friendly IDE (like Visual Studio Code) and you must have Node installed on your system. To clone the repository and install dependencies run:
$ git clone git@github.com:alvarhonsi/Vaffelbot.git
$ cd Vaffelbot
$ yarn install
You can now start development. To start the bot simply run node main.js. The bot will then be hosted locally on your machine, and it can be added to a discord server for testing. If you have already created a bot-application on the discord developer portal, then you can follow this guide for how to add the bot to a server.
If you have followed the steps above and want to contribute to the project, this is what you need to do. Assuming you have already forked the project, you can commit your changes to your forked repository. You should then be able to create a pull request to the original main branch. We will then review the code and give feedback if any changes are needed. If there are no problems with the code it will be merged into the main branch for deployment. 🚀
MIT