Push GitHub issues to HelpScout
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
databases
src
.gitignore
.prettierrc
.travis.yml
README.md
issue.sample
jest.config.js
package.json
renovate.json
tsconfig.json
tslint.json
yarn.lock

README.md

GitHub HelpScout Collector

This is a server to collect issues events from GitHub through webhooks and sent them to HelpScout with the Mailbox API 2.0. To link repositories to mailboxes we use the file databases/data.json as database. You have to create the file before running the server, it does not exist by default. The stucture looks like this:

{
  "data": [
    [
      "<mailboxId>",
      [
        "<repoId>",
        "<repoId>"
      ]
    ]
  ]
}

Run the production server

GITHUB_WEBHOOK_SECRET=yourGitHubWebTokenSecret \
HELP_SCOUT_APP_ID=yourHelpScoutAppId \
HELP_SCOUT_APP_SECRET=yourHelpScoutAppSecrect \
yarn start

Run the devlopment server

GITHUB_WEBHOOK_SECRET=yourGitHubWebTokenSecret \
HELP_SCOUT_APP_ID=yourHelpScoutAppId \
HELP_SCOUT_APP_SECRET=yourHelpScoutAppSecrect \
yarn dev

Run the build

yarn build

Run the test

yarn test