Minimal example of a GitHub App using [octokit.js](https://github.com/octokit/octokit.js).

- Node.js 12 or higher

- A GitHub App subscribed to **Pull Request** events and with the following permissions:

- Pull requests: Read & write

- Metadata: Read-only

- (For local development) A tunnel to expose your local server to the internet (e.g. [smee](https://smee.io/), [ngrok](https://ngrok.com/) or [cloudflared](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/local/))

1. Clone this repository.

2. Create a `.env` file similar to `.env.example` and set actual values.

3. Install dependencies with `npm install`.

4. Start the server with `npm run server`.

5. Ensure your server is reachable from the internet.

- If you're using `smee`, run `smee -u <smee_url> -t http://patman.localhost:3000/api/hook`.

6. Ensure your GitHub App includes at least one repository on its installations.

With your server running, you can now create a pull request on any repository that

your app can access. GitHub will emit a `pull_request.opened` and will deliver

the corresponding Webhook [payload](https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads#pull_request) to your server.

The server in this example listens for `pull_request.opened` events and acts on

them by creating a comment on the pull request, with the message in `message.md`,

using the [octokit.js rest methods](https://github.com/octokit/octokit.js#octokitrest-endpoint-methods).