0-vortex / dark-elise-bot

A multi-purpose demo Discord bot built with discord-akairo and deployed to Heroku.

dark-elise-bot

Overview

Dark Elise is an open source, multi-functional Discord bot that is constantly growing.

The codebase also serves as a base framework to easily create Discord bots of all kinds.

You can test drive the ping command by using this link.

Folder structure

A quick look at the top-level files and directories you'll see in a Gatsby project.

├──── dark-elise-bot
│  ├── .github/
│  ├── src/
│  ├── .editorconfig
│  ├── .eslintrc.js
│  ├── .gitattributes
│  ├── .gitignore
│  ├── .lintstagedrc.js
│  ├── .npmrc
│  ├── compose.yml
│  ├── Dockerfile
│  ├── LICENSE
│  ├── npm-shrikwrap.json
│  ├── package.json
│  └── README.md

Installation

Clone the package via git:

git clone [e-mail]:0-vortex/derk-elise-bot.git

Requirements

This repository requires node>=v14.16.0 to be installed.

How to use

This repository is featuring granular controls fully orthogonal to environment variables as specified by the twelve-factor app guidelines.

In order for the application to run we need the following environment variables set similar to the following example. Without these variables the application will fail to start, so in order for the app to start locally we need to create an .env file with the following values:

BOT_TOKEN=UzE8OTY2NTBzNjczNzkwNDY0.BTWWBw.UwhtObbCJxVFLRkhqx48I7jL8Ys
NPM_CONFIG_PRODUCTION=false
RICH_PRESENCE_STATUS=true

To develop locally just run:

npm start

Contributing

This repository uses husky with pre-commit and message hooks. All you need to do after staging some files is to run:

npm run push

License