NullBot for Discord

This is a bot that I'm building to serve the Discord servers that I'm in, as well as helping me to keep up to date with node.js and TypeScript.

Usage

Documentation

Please see the wiki for documentation on the usage of the bot, such as commands.

Installation / Hosting (TBD)

Deploy on your server:

• Create a target directory for the node application and copy the following:
  • The dist, migrations directories, preserving the path
  • The package*.json files
• Copy .sample-env to the target directory as .env
• Edit .env and provide the necessary values
• Run npm install
• Run node dist\index.js (you'll want to use a process restart monitor)

Developing NullBot features

Prerequisites

You'll need:

• node.js, npm, gulp
• Discord client
• Your own Discord server for testing the bot
• Application credentials from the Discord developer portal

Discord

In order to test the changes you make, you'll need to create an Application via the Discord website.

You'll also need to invite your bot to your test server. Replace <your client id> with the one from the application you created in the previous step.

https://discordapp.com/oauth2/authorize?client_id=<your client id>&scope=bot

Dev Container (TBD)

Development Configuration

You'll need to copy .sample-env to .env and provide values for each of the keys within.

npm tasks / gulp tasks

Run the bot locally and watch for changes to the source files:

npm start

You can use npm run by itself to list all the available scripts.

Testing (TBD)

Linting

Linting rules are enforced by tslint. Please refer to TSLint Rules for more information.

References

API Documentation

• Discord - The base Discord API
• discord.js - Provides a JavaScript/TypeScript implementation of the Discord API
• discord-akairo - The command framework used in the bot