This is a WIP project, so some stuff is unfinished (such as the web interface). However everything listed below works fine.

BugBoy

BugBoy is a Discord bot and web interface built using Node.JS. It serves as a simple way of tracking bugs.

Usage

Adding a bug report

You can add a bug report by sending the following message in any channel of the server:

/bug<bug title>

The bare minimum for a bug report is the title, however you can add more details with the following flags (in any order):

/bug<bug title> /details<more details about the bug> /platform<name of the platform the bug is occuring on> /severity<how bad the bug is, from 1-10>

By default, platform is set to all and "severity" is set to 1.

Other commands

Action	Command(s)	Description	Example
View help	/bug	View all commands available to the user who asked
List bugs	/bugs, /buglist	List all the bugs
View bug details	/bug	View details about a specific bug, specified by index	/bug 4
Remove a bug	/bugremove, /bugdelete	Remove all bugs, specified by position.	/bugremove 4, 12 2 and 3
Mark a bug as fixed	/bugfix	Mark a bug as fixed	/bugfix 2, 3
Respond to a bug	/bugrespond, /buganswer	Add a response to the bug specified by index	/bugrespond 12 this is kind of fixed
Move a bug	/bugmove	Move a bug from it's first position to a new one	/bugmove 12 to 1
Bot info	/bugboy	View information about the node process

Notes

• Anyone can report a bug, or view the bug report list, but only members with a role ID that exists in the adminroleids array (index.js:38) can use the other commands.

• The /bugremove, /bugfix, and/bugmove commands can have any non-numeric characters between the bug report positions. For example, /bugmove 12 2 is just as valid as /bugmove 12hello2 or /bugmove 12 to the position 2. This makes it easy to use extremely human-readable and intuitive commands.

• BugBoy does not differentiate between servers, adding a bug report in server A will show up in server B.

Installing to your server

Because of the way it works, BugBoy isn't a "public" bot you can just add to any server. You need to host it yourself.

Prerequisites

• A place that can run a node.js app (We use an Amazon EC2 server)

• An MongoDB database (We use https://mlab.com/)

• A Discord bot application (You can create one here)

Installation

1. Login to your server with SSH

2. Install node (Very simple, just follow this)

3. Run npm install git

4. Run git clone https://github.com/QuarrelForDiscord/BugBoy.git

5. Create a new file called .env at the root of the repo you just cloned (nano BugBoy/.env)

6. Now edit it so that it looks like this:

databaseurl=<The URL of you MongoDB database>
bottoken=<The token of your Discord bot>

7. Now you could just run node BugBoy/index.js, but the process would shut down shortly after you close the SSH connection. So the better option is to install a utility called forever which will fix this issue. Run npm install forever.

8. Now, to start your bot, simply run the command forever start BugBoy/index.js.