Pull Request Dashboard

Usage

Development Environment

• Make sure you have an instance of MongoDB running or use a external Mongo Database Provider.
• Clone the repository with git clone <repository url>
• Install the dependencies yarn install
• Create a .env file in the root folder with the required keys. You can find an example in .env.example.
• To fetch all initial information from GitHub execute node ./bin/cronjob.js

Deploy to Heroku

To deploy the Pull Request Dashboard to Heroku, follow the following steps:

• Install Heroku CLI
• Change to project directory and be sure to login with your Heroku credentials heroku login
• Add the Heroku Remote Repository to your git config heroku git:remote -a pr-dashboard-server
• Push the repository to Heroku git push heroku master
• Add Config variables on Heroku. Select Project > Settings > Config Vars. You can compare the config variables with .env.example.
• Install Heroku Scheduler as an Add-on in your Heroku Environment. Add cronjob.js (only the filename, NOT the full path) to the scheduler to be executed every 10 minutes.

API

To use the API, you can check the documentation here.

Tech Stack

• Node JS
• Express JS
• Mongoose

Team

Carmelo Carrillo - GitHub

Dave Martínez - GitHub

José Manuel - GitHub

Goran Plavsic - GitHub