reconman / github-reddit-bot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GitHub Reddit Bot

Build Status

A bot that watches GitHub repositories for changes and automatically submits them to an appropriate subreddit.

The dev instance of the bot is hosted on Heroku and can be accessed via https://github-reddit-bot.herokuapp.com/.

How it works

Deploying the bot

Clone the repository to your local machine and install all NPM dependencies:

git clone https://github.com/TimboKZ/github-reddit-bot.git
cd github-reddit-bot
npm install

Copy and rename config.example.json to config.json and amend it as necessary. Once you're done, you can start the bot using node index.js. Keep in mind that your server URL will have to be publicly available for GitHub hooks to work.

Reporting issues

Please create a thread with your issue here. We'll try to resolve all issues as quickly as possible.

Contributing

Before making a pull request, make sure npm test and npm run lint commands return no errors or your pull request will be rejected.

About

License:GNU General Public License v3.0


Languages

Language:JavaScript 83.0%Language:HTML 17.0%