Name: captain-hook
Owner: npm
Description: slack bot that provides subscription service for npm webhooks
Created: 2016-05-19 15:05:57.0
Updated: 2018-01-22 18:47:13.0
Pushed: 2016-07-05 22:22:50.0
Size: 358
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
a slack bot to subscribe to npm webhook notifications
tain-hook subscribe <type: package||organization> <name> <sharedsecret>
captain-hook is a NodeJS application. if you don't have NodeJS
you'll need to download it.
captain-hook uses a Postgres database.
Fork and clone this repo
cd captain-hook
npm install
Copy .envsample to .env and fill it out
| variable | description |
|—————— |—————————————————————————————————————————————————————————- |
| SLACK_API_TOKEN | Bot API token. You can find this on the Slack Developers site by navigating: Browse Apps > Custom Integrations > Bots Configurations on {{team_name}} > Edit configuration |
| SLACK_CHANNEL_ID | Name of the channel, i.e. #testing. Can also be ID number retrieved from the Slack API. |
| SHARED_SECRET | Any string. |
| DATABASE_URL | URL of your Postgres database. defaults to localhost:5432/dev |
npm db:setup, creates a Postgres db, then runs Knex migrations and seeds
npm run dev, runs npm start and pipes output to nice logging
You now have a service running on localhost:6666. You'll probably want to expose
that to the internet for local development. ngrok is a great, free option.
the captain hook web interface is an express app. it servers basic CRUD functionality for the two resources: users and subscriptions.
to start it, run npm run start:web and then visit http://localhost:8080.