ctome
/
hullcss-discord-bot
mirror of https://github.com/CrimsonTome/hullcss-discord-bot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
344 Commits
2 Branches
0 Tags
25 MiB
JavaScript 100%
 
Go to file
KieranRobson bafb6c1342 chore: Run ci 2022-12-05 22:39:03 +00:00
.github feat!: Add lint action and change to yarn 2022-12-05 22:38:23 +00:00
docs docs: Wrote up Terms of Services 2022-09-21 19:16:17 +01:00
src chore: Run ci 2022-12-05 22:39:03 +00:00
.cspell.json feat: Add spell action 2022-12-05 22:36:38 +00:00
.dockerignore chore: Update ignore files 2022-09-21 19:01:50 +01:00
.env.template Fix env template 2022-08-27 21:30:50 +01:00
.eslintrc.json style: Eslint changes to get rid of errors 2022-09-21 19:06:13 +01:00
.gitignore chore: Update ignore files 2022-09-21 19:01:50 +01:00
.prettierrc ESLint and spelling 2022-09-10 09:32:54 +01:00
LICENSE Change License from Apache to MIT 2022-07-02 11:56:20 +01:00
README.md fix: CSpell and Typo 2022-11-05 23:37:11 +00:00
dockerfile build(deps): bump node from 19.1.0 to 19.2.0 (#48) 2022-11-30 08:05:51 +00:00
package.json build(deps-dev): bump cspell from 6.15.1 to 6.16.0 2022-12-02 22:44:58 +00:00
yarn.lock feat!: Add lint action and change to yarn 2022-12-05 22:38:23 +00:00

README.md

HullCSS Discord Bot

This bot is a multipurpose discord bot for The Hull Computer Science Society Discord server.

This bot features multiple command types from:

  • Admin
  • Embeds
  • Fun
  • General
  • Slash Commands

Alongside commands, this bot also features:

  • Auto threading in #coursework-help channel to keep it clean
  • Auto embedding of events for information and archiving
  • Select menu role system within #roles
  • Rule agreement button embed with #code-of-conduct

Installation

This is a private bot used for a specific purpose within a specific discord server however if you do want to run the bot for testing purposes or deploy it to a new location. Follow the instructions below.

🐋 Docker

Due to the Publish.yml workflow, the newest build will automatically be pushed to DockerHub.

docker run -d \
--name=hullcss \
-p 6001:6001 \
-e DISCORD_TOKEN='INSERT DISCORD TOKEN' \
-e PREFIX='!' \
--restart unless-stopped \
kieranr27/hullcss:main

Using a tool like Ouroboros, you can automatically update containers without the need for restarts.

👷 Manual

  • Clone the repo
  • Remove the .template from .env.template
  • Replace INSERT DISCORD TOKEN with your Discord token.
  • Run npm i to install packages
  • Run node . to run the bot

Contributions

While this bot is maintained by Kieran, contributors are welcome!

  • Contribution guidelines are coming soon.

License

hullcss-discord-bot is licensed under the MIT License. The full license text is included in the LICENSE file in this repository. Tldr legal have a great summary of the license if you're interested.