Skip to content

Bekt-Clan/bingo-bot

Repository files navigation

Bingo Bot

A Discord bot used for running bingo events in the Bekt Clan.


Documentation

This project is built using the discord.js module. It generally follows a typical discord.js project structure.

If you are looking to get started understanding the code, it is recommended to first familiarize yourself with discord.js's documentation. It is very helpful, and will explain most of the background needed to understand this repo.

The code QA is done with ESLint and Prettier. It is strongly recommended to use Visual Studio Code with the ESLint and Prettier extensions installed to work on this project.

The Bekt clan currently hosts the bot's live application code on Railway (we maintain both a production and test environment).

License

This project is licensed with the MIT License. All use of this code is permitted. Acknowledgement of the Bekt clan and current project maintainers is requested if you found this repo helpful in any way. Please use the following block of text:

Bingo Bot Acknowledgements
https://github.com/Bekt-Clan/bingo-bot
-   Bekt Clan: https://discord.gg/ujYPb8pcce
-   Maintainers:
    - Thomas/TR0P - https://github.com/tomking
    - Dennis/Kojonkler - https://github.com/Kojonkler
    - Disni - https://github.com/Disniew

Contributing

Contributions to this project are welcome from all members of the community. Feel free to open issues within this repo to discuss anything related to the technical aspects of the system (bug reports, feature requests, etc.). Use the #suggestions channel in the clan's Discord server for anything more general regarding bingo events. No support will be offered for the bot through this repository (use the #tickets channel in the Discord server if you require assistance).

If you would like to help out with the code please see the open issues or contact the current maintainers to get started. Pull requests are always welcome and all help is appreciated! If you intend to open a pull request please do so on the dev branch and write clear documentation both within your code and within your PR/commit messages.

About

A Discord bot used for running bingo events in the Bekt Clan.

Resources

License

Stars

Watchers

Forks

Contributors