TeX-Bot, but now in JS! This is a Discord bot used for managing the CSS Discord server.
Ensure you have NodeJS and Yarn installed, then navigate to the root folder and enter the following into the console:
yarn
You'll need to create a Discord bot of your own in the Discord Developer Portal. It's also handy if you have an empty server (or "guild") for you to test in.
You'll need to set a number of environment variables:
- DISCORD_TOKEN -> The Discord token for the bot you created (available on your bot page in the Developer Portal).
- CLIENTID -> The application ID of the bot (available in the Developer Portal).
- GUILDID -> The ID of the Guild/Server the bot will be operating in.
- UNION_URL -> The URL of the Guild of Students members page (make sure it's sorted by group).
- UNION_COOKIE -> A Guild of Students session cooke (probably listed as
.ASPXAUTH) so the bot has permsision to view your members list (you can extract this from your web browser after logging into the Guild of Students website. You must be a Committee member.)
You can put these in a .env file in the root folder as it uses dotenv so you don't have to keep them in your environment. There is an example.env file in the repo that you can rename and populate.
Contributions are welcome. If you want to contribute, please raise a PR and we'll review, test and (likely) merge it. Please comment on issues you'd like to work on for assignment to prevent duplicatation of work. If you find any bugs/problems or have any feature suggestion, please raise an issue.
Please utiise the Prettier and ESLint files so that the repo has a consistent style.