README.md (1511B)
1 # is-a.dev reviewbot 2 3 This is the source code of the is-a.dev reviewbot! The bot uses [octokit.js](https://github.com/octokit/octokit.js) as the library. 4 5 ## Requirements 6 7 - pnpm and Node.js 8 - A GitHub App subscribed to **Pull Request**, **Workflow job** and **Workflow run** events with the following permissions: 9 - Pull requests: Read & write 10 - Metadata: Read-only 11 - Actions: Read-only 12 - (For local development) A tunnel to expose your local server to the internet (e.g. [smee](https://smee.io/), [ngrok](https://ngrok.com/)) 13 - Your GitHub App Webhook must be configured to receive events at a URL that is accessible from the internet. 14 15 ## Setup 16 17 ### Manual 18 1. Clone this repository. 19 2. Create a `.env` file similar to `.env.example` and set actual values. 20 3. Install dependencies with `pnpm`. 21 4. Start the server with `pnpm run server`. 22 5. Ensure your server is reachable from the internet. 23 - If you're using `smee`, run `smee -u <smee_url> -t http://localhost:3000/api/webhook`. 24 6. Ensure your GitHub App includes at least one repository on its installations. 25 26 ### Docker 27 1. Clone this repository. 28 2. Add the private-key.pem file to the same directory. 29 3. Create a `.env` file similar to `.env.example` and set actual values. 30 4. Run `sudo docker compose up -d` 31 32 ## Contributing 33 34 Any contribution to the is-a.dev reviewbot is welcomed! If you have any suggestions or fixes that you want to make feel free to make a pull request or make a GitHub issue! To get it resolved faster you can contact me.