jdboisvert / review-rush

A Slack Bot used to show the ranking of who did the most code reviews in a given day.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Review Rush

A Slack bot used to show who the top reviewers were in GitHub for a given day.

Setting Up and Running the Project with Slack Integration

Prerequisites:

  1. Go: Ensure you have Go installed. Download and install Go.
  2. Slack Token: Obtain a Slack token (by creating an app) to enable posting messages. Follow Slack's documentation to get one.
  3. Slack Channel: Create a Slack channel to post messages to. Follow Slack's documentation to create one.
  4. GitHub Token: Obtain a GitHub token to enable fetching data from GitHub. Follow GitHub's documentation to get one. Ensure it has the following scopes public_repo, read:project, read:user, repo:status, user:email. When making this project I simply used a Classic Token. Ideally just using a Fine-grained personal access token would be better since scoping by organization or user would be more secure.

Quick Start:

  1. Clone the Repository:

    git clone git@github.com:jdboisvert/review-rush.git
    cd review-rush
  2. Set Environment Variables:

    cp .env.example .env

    This project makes use of a .env file you need to copy .env.example to .env and fill in the values.

  3. Build the Project for Quick Use using /cmd:

    cd ./cmd
    go build -o ../review-rush.exe
  4. Run the Built Executable:

    cd ..
    ./review-rush.exe

    You can skip the build process and run the project directly using go run ./cmd/main.go from the root of the project as well.

  5. The application should now be running and posting to Slack as intended! image

Development Configuration:

If you need more configuration options or to understand deeper aspects of the integration, visit this detailed guide.

About

A Slack Bot used to show the ranking of who did the most code reviews in a given day.


Languages

Language:Go 100.0%