Skip to content

mjkaufer/Comrat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Comrat

Comrat sends you GitHub notifications through your desktop!

Installation

Run npm install in the directory where you've cloned the project. This will install everything. Ngrok will automatically tunnel an ngrok url to your node app. Copy the URL outputted - you'll use it in the next step.

Go to a GitHub repo you want to track (currently, you can only track repos you own) and go to Settings > Webhooks & Services > Add Webhook. Add the ngrok url from the step before with /post appended to the end - e.g. http://1234.ngrok.com/post - to the payload URL.

Select Let me select individual events in the trigger options menu and select Push, Pull Request, Issues, and Member. Of course, if you don't want to track any of these events specifically, don't check them.

Now, with your node server running, you'll receive notifications for any of the supported events below!

The ngrok URL should remain persistent for your server but, if you want a customized ngrok url or want to use your own server, simply open up main.js and mess with the line containing ngrok.connect.

Make sure you've installed growl correctly! Check out the instructions here!

Supported Events

  • Pushes
  • Pull Requests
  • Issues
  • Member Additions

Comrat also includes the icon of whoever triggered the event in your notification!

Screenshots

Push Notification

Push Notification

Todo

  • Support for more events
  • Dynamic webhooks
    • Listen for any URL, be it your repo or not
  • Standalone app
    • Independent of node
  • Better ngrok persistency

If you think you can do any of the things in the todo or have your own idea, feel free to drop a pull request!

About

❗ GitHub notifications on the desktop!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published