markrmessmore / elihubot Goto Github PK

This was written using Discord.JS 12. I'd like to update to version 14, however, it will require a rewrite.

NOTE: I welcome PRs for pieces of the following. Please don't just add a single link and submit a PR, however, if you do a section of the documentation, or document a process with screenshots, I'll gladly accept that.

I want to develop documentation for users who have never set up/administered a discord bot. This will include, but not be limited to, the following:

Branding

• A better name, header image and/or logo

Use Cases

Background Information

(External links permitted in this section)

• How to install NodeJS on your server environment
• How to download a github repo onto your server
• Installing Node dependencies using NPM
• Using PM2 (or other software) to run as an ongoing service (Options for various environments)
• Using Editors to edit source code files in various environments

Setting up a bot in Discord

• Accessing the developer portal
• Obtaining a Discord Token
• Inviting Your Bot to the Server
• Finding Your Guild ID & Selected Guild Channel ID

Bot Configuration and Use

• Adding the necessary variables
• Configuring multiple RSS listeners
• Customizing Discord Messages
• Testing your bot

Setup docker-compose.yml for easy install and use.
Add config file instead of having to edit index.js