hullcss-discord-bot

Go to file

github-actions[bot] ac000901e9 chore(deps): Bump yarn dependencies (#219 ) Co-authored-by: KieranRobson <KieranRobson@users.noreply.github.com>		2023-11-01 07:25:24 +00:00
.github	build(deps): bump the github-actions group with 2 updates (#218 )	2023-10-26 12:17:00 +01:00
docs	chore: Run format	2022-12-05 22:44:54 +00:00
src	feat: Create Poll and Helper commands	2023-10-12 11:23:01 +01:00
.cspell.json	chore: Fix spell	2023-08-24 20:26:35 +01:00
.dockerignore	chore: Update ignore files	2022-09-21 19:01:50 +01:00
.eslintrc.json	fix: Add eslint ignore for md files	2023-08-21 15:57:11 +01:00
.gitignore	chore: Update ignore files	2022-09-21 19:01:50 +01:00
.prettierignore	fix: Add prettier ignore	2023-08-21 15:58:45 +01:00
.prettierrc	chore: Run format	2022-12-05 22:44:54 +00:00
CHANGELOG.md	chore(main): release 4.1.0	2023-08-22 14:12:48 +00:00
LICENSE	Change License from Apache to MIT	2022-07-02 11:56:20 +01:00
README.md	Add Docker Compose support (#205 )	2023-09-20 15:36:06 +01:00
docker-compose.yml	Add Docker Compose support (#205 )	2023-09-20 15:36:06 +01:00
dockerfile	build(deps): bump the docker-dependecies group with 1 update (#217 )	2023-10-26 12:17:09 +01:00
package.json	chore(deps): Bump yarn dependencies (#216 )	2023-10-23 09:15:57 +01:00
release-please-config.json	chore: Run format	2022-12-13 11:18:08 +00:00
yarn.lock	chore(deps): Bump yarn dependencies (#219 )	2023-11-01 07:25:24 +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

Or if you are using Docker Compose

docker compose up -d

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.