https://github.com/kainosnoema/jim

Simple webhook server
https://github.com/kainosnoema/jim

Last synced: 2 months ago
JSON representation

Simple webhook server

• Host: GitHub
• URL: https://github.com/kainosnoema/jim
• Owner: kainosnoema
• Created: 2012-06-08T01:05:05.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-06-08T22:13:40.000Z (over 12 years ago)
• Last Synced: 2024-11-27T13:37:29.342Z (3 months ago)
• Language: JavaScript
• Size: 138 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

• awesome-github-repos - kainosnoema/jim - Simple webhook server (JavaScript)

README

        
# Captain James "Jim" Hook

Simple webhook server, built on [node](http://nodejs.org).

NOTE: In early-stage development.

## Installation

    $ npm install -g jim

## Quick Start

Install server

    $ npm install -g jim

    $ jim install ./jim

    $ cd jim

Add a webhook with a shell command

    $ jim add deploy-project -c "echo 'Prepare to die, Peter Pan!'"

  ... or from an existing script

    $ jim add deploy-project ~/project/deploy.sh

Run the hook directly

    $ jim run deploy-project

Start the webserver

    $ jim server -p 8080 &

Trigger the hook remotely with env vars

    curl -X POST http://localhost:8080/hooks/deploy-project?branch=staging

    # hook script is run with `JIM_BRANCH=staging`

## Features

So far:

  - Easy CLI

  - HTTP API

(in development)

## Todo

  - Authentication

  - Tests

## License

(The MIT License)

Copyright (c) 2012 Evan Owen <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

'Software'), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.