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. You can then relay this information by binding it to a specific channel. We are tailoring this bot to output messages in a more clean fashion.

Installation

1. npm install
2. node bot.js
3. Remember to create a webhook and set the Payload URL to http://YOURIP:8080/webhook with application/json

Documentation

Pre-requisites for Project

1. eris
2. forky
3. github-webhook-handler
4. http
5. eslint
6. foreman

Configuration (config/auth.js)

Configuration	Description
config.discord.token	Discord Bot Token. You can find out more here.
config.discord.channel_id	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.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

github-webhook-handler (GitHub Webhook Library or "middleware" handles all the logic of receiving and verifying webhook requests from GitHub)
eris (NodeJS Discord Wrapper)
nandun (Base Code)