Skip to content

Latest commit

 

History

History
74 lines (47 loc) · 2.11 KB

README.md

File metadata and controls

74 lines (47 loc) · 2.11 KB

Build Status Coverage Status

PR Dashboard

PR Dashboard is a pull requests reviewing tool build on top of a Rails as backend service, and Ember.js as frontend framework.

It's alive

There is an instance of PR Dashboard running on prs.crowdint.com. Give it a try!

Requirements

  • Ruby 2.1.1
  • Rails 4.1.1

Github Keys

There are only two needed enviroment variables for this application. But first, you will have to create a new Github application, to do so, just go here.

For development enviroment you should set the Homepage URL as http://localhost:$PORT

After that, you will get access to your tokens.

You need to set the following enviroment variables, you could create a .env file on the application's root. That file should look like this:

GITHUB_KEY=your-key
GITHUB_SECRET=your-secret
SECRET_TOKEN=3c129645bbb2ca4b21ff1998bba2339adf86c06ea247a9086bc353ad7220c56c5af587b1a6946b
ANALYTICS_ID=your-google-analytics-id
ANALYTICS_DOMAIN=your-google-analytics-domain

The SECRET_TOKEN value is just an example.

Setup

After cloning the repo, all you need to do is:

$ bundle install
$ cp config/database.yml.postgresql config/database.yml
$ bundle exec rake db:create
$ bundle exec rake db:migrate
$ bundle exec foreman start

And you are done!

Specs

All the Rails backend is almost covered with RSpec. To run the test suite, use:

bundle exec rspec

There is also a test suite for the Ember.js frontend app. To run those specs, use:

bundle exec rake konacha:serve

And open your browser on: http://localhost:3500

It has a command line runner too, the command is:

bundle exec rake konacha:run

Contributions

Pull requests are welcome, just fork the repo, make your changes (don't forget to add tests) and send the Pull Request. That easy!