/csc648-discord-bot

Discord bot written in Go for my software engineering course

Primary LanguageGo

csc648-discord-bot

A bot used in my software engineering team's Discord server.

I. Built with

II. Motivation

I wanted to create something in Go and creating a discord bot in order to make my team's lives easier was a good motivator!

III. Purpose

The purpose of the bot is to return important information related to the class. It currently only returns the database instance assigned to each user in data.json.

See .example.data.json for what data.json should look like.

IV. Commands

These commands will work in any channels the bot has access to.

Command Description
!db Returns the connection details of the database instance assigned to you

V. Usage

Prerequisites

  • Create a Discord bot here and invite it to your server.
  • Copy the contents of .example.data.json to a file called data.json and fill it out.
  • Copy the contents of .example.dev to a file called .env and add your bot token to it.
  • Docker and Docker compose

Running the bot with Docker

Make sure you are in the root directory of the project when running these commands.

  1. Launching the bot:
  sudo docker-compose up --build -d
  1. Stopping the bot:
  sudo docker-compose down