README.md

Fixrbot

Fixrbot is a GitHub App that analyses the API usage patterns of the Java Programming Language. Go to the public github app page to integrate this app into your java application build pipeline. This project is built upon the Probot project.

Setup Locally

Install Dependencies

npm install

Run the bot

npm run build
npm start

Run tests

npm test

Configuring the Github App

You need to a corresponding Github App to use the bot on Github. You can follow either the instructions of configuring a GitHub app automatically or Manually Configuring a GitHub App. The important part is to set up the environment variable in .env and download the private key from the Github App into the root of this project.

Deployment

The bot is currently deployed on heroku, refer this section of the probot documentation to learn more.