Skip to content

A Slack BoltJS bot to track code review status

License

Notifications You must be signed in to change notification settings

penske-media-corp/code-review-bot

Repository files navigation

PMC Code Review Bot


Getting started


Pre-requisites

  1. Node.JS and NPM
  2. git
  3. Node Version Manager (nvm)
  4. mysql/mariadb

Environment Setup

To get needed repositories and applications:

  1. Clone the following repos in the directory where you want the project to live (use code snippet below):
    git clone [email protected]:penske-media-corp/code-review-bot.git
    
  2. Go into the code-review-bot directory (ie. cd code-review-bot). All instructions below will assume that you are in this directory.
  3. Copy .env.example to .env and edit the API & Secret key variable.
    • Make sure the mysql/mariadb service is up and running.
  4. Install the nodejs packages & setup the database schemas for the first time:
    nvm install && npm run dev-once
    
  5. Start the local development environment
    ./dev.sh