nerd-junior

This is a utility bot that handles specific functions in Suggestions-related Discord servers.

Creating A Discord Application & Bot

You should have a Discord Bot Application ready and made to work on this bot. If you're not sure how to do that, please follow this guide.

A star is always appreciated and if you wish to contribute, feel free to open an issue or pull request

Running Locally

Make sure you have Node.js installed as well as Git SCM Windows | Mac | Linux if you're going to go this route. Otherwise, simply clone the repo or download it and unzip it to a folder on your desktop.

$ git clone [email protected]:suggestionsbot/nerd-junior.git # or fork
$ cd nerd-junior
$ npm install

Rename .env.example to .env and update the file with its respective details. Afterward, start the bot.

$ npm start

The bot should now be live! (Check the console if you need to double check anything.

Deploying to Heroku

With the included Profile you have the option of deploying the bot to Heroku.

Make sure you have Heroku CLI installed before proceeding. You will need to download the Heroku Node.js buildpack first before moving along.

$ heroku create --buildpack https://github.com/heroku/heroku-buildpack-nodejs.git

Once the buildpack is installed, you may proceed with deployment.

$ heroku create
$ git push heroku master
$ heroku open

or

Minimum Permissions

Down below you will find the minimum permissions for the bot to fully function. Modifiying/removing some of these permissions may cause unwarranted problems.

• Manage Roles [MANAGE_ROLES]
• Kick Members [KICK_MEMBERS]
• Read Messages & View Channel [VIEW_CHANNEL]
• Send Messages [SEND_MESSAGES]
• Embed Links [EMBED_LINKS]
• Read Message History [READ_MESSAGE_HISTORY]

Permission Bit Integer: 268520450

Credits to Joma for the README template