discord-bot-github

Table of Contents

• What is it?
• Installation
• Documentation
• Contributing
  • Core Maintainers
• Licensing
  • Third Party Licenses
• Credits

What is it?

discord-bot-github is an open source bot for sending GitHub Webhooks to Discord by binding messages to a specific channel.

Installation

1. npm install
2. Copy config/auth.js.example to config/auth.js
3. Configure config/auth.js
4. node bot.js
5. Remember to create a webhook and set the Payload URL to http://YOURIP:8080/webhook with application/json

Having issues or just have a good idea? Please submit an issue.

Documentation

Pre-requisites for Project

1. eris
2. forky
3. github-webhook-handler
4. http
5. eslint
6. foreman
7. goo.gl
8. semver

GitHub Webhook

Want to learn more about GitHub Webhooks and it's event handlers? You can also check out the GitHub API Status.

Eris, a NodeJS Wrapper for Discord

Eris, NodeJS Discord Library, is speedy, consistent, flexible, predictable, and a simple command framework. You can find out more about the library usage by going to their Documentation

Configuration (config/auth.js)

Configuration	Description
config.googl	This is used for URL shortening, if you wish to keep default Github links, use an invalid key as the key or keep it blank. You can find out more here.
config.discord.token	Discord Bot Token. You can find out more here.
config.discord.channelID	Input the Discord channel ID that you want to bind the bot to.
config.github.token	Input the GitHub Webhook Secret/Token that you created.
config.github.logspath	Input the absolute path to the folder you wish to save the logs into.
config.web.cname	Don't Touch Me Please. Only if you have to.
config.web.url	Don't Touch Me Please. Only if you have to.
config.web.workers	Don't Touch Me Please. Only if you have to.
config.web.path	Don't Touch Me Please. Only if you have to.

Licensing

GNU GPL v3.

Third Party Licenses

None

Contributing

Currently, you can contribute to this project by:

• Submitting a detailed issue.
• Forking the project, and sending a pull request back to for review.

Core Maintainers

• - fkndean

• - Lisiano256

Credits

1. github-webhook-handler

• GitHub Webhook Library or "middleware" handles all the logic of receiving and verifying webhook requests from GitHub

2. eris

• NodeJS Discord Wrapper

3. nandub

• Base Code