Captain Hook

Open webhook service

Run your tasks behind a webhook.

Requirements

• node
• npm

Installation

• npm install ( or yarn, if you prefer )

If typings install does not work, consider adding ./node_modules/.bin to $PATH.

Reporting issues

• Look for any related issues.
• If you find an issue that seems related, plase comment there instead of creating a new one.
• If you find no related issue, create a new one.
• Include all details you can ( operative system, environment, interpreter version, etc.. )
• Include the error log.
• Remember to check the discussion and update if there are changes.

Contributing

• Fork the repository
• Create your feature branch
• Commit your changes and push the branch
• Submit a pull request

Start development

• npm run dev to start all transpilers.
• npm run dev:core to start core transpiler.
• npm run dev:frontend to start frontend transpiler.

Test

Run yarn or npm install, then npm test.

Project structure

build contains the transpiled code for development stages.
config contains sequelize configuration. dist contains the transpiled code for production stages.
migrations contains sequelize migrations. seeders contains sequelize seeders.
src/core contains the application logic source code. Entrypoint index.tsx.
src/frontend contains the source for the frontend javascript. Source starting from index.tsx.
test contains unity and integration tests.

Ideas

Options

• pipe - Would allow the task to print the output and send it back to the request.
• content-type - Would allow to set the content-type.
• x-hub-signature - Would allow to check x-hub-signature header ( requires secret to be set ).
• secret - Would allow a signature check.

Task Creation/Update

• --before <id> --after <id> - Create a task and put it after the task with .

Known issues

• ...