Skip to content

Nucc/check.it

Repository files navigation

The Code Review Tool

Check.it is a simple code review tool for Git focusing on easy usage. You can find more information on http://nucc.github.com/check.it.

How to install

Environment

First you need to have Ruby (>=1.8.7) and rubygems packages on your machine.

I suggest you to follow the instructions on the next page:

Install the bundler gem that will manage the dependencies

gem install bundler

Initializing the app

Install dependencies to .gems directory (without --path the gems will be stored in your $HOME/.gems)

bundle install --path .gems

(you may have to use bundle update before installing)

Create your database configuration in config/database.yml and migrate it. You can use the sample configuration file if you want to use sqlite3 database engine.

cp config/database.yml.sample config/database.yml
bundle exec rake db:migrate

Clone your repositories to APP_DIR/repositories directory (you can change its location in config/config.yml with repository_path variable).

cd repositories
git clone https://github.com/Nucc/check.it.git

Important: Don't use bare repositories because the current implementation finds the .git directory in the repository's directory.

Launch

Before launching, prepare your configuration file at /config/config.yml

cp config/config.yml.sample config/config.yml

I suggest you to use Passenger tool with Apache or Nginx, or use Thin server and proxy all the request to it.

For developing I suggest you the embedded server that you can run by

bundle exec rails server

Note: If you want to use it in production use the RAILS_ENV=production environment setting (you should migrate the database with this setting too)

Sending notification emails

You can send notification emails about unread review messages to developers. Just create a cronjob file and run rake send_notifications command every morning.

Note: Don't forget to set the site_url field in config/config.yml to email contains the url to your application!

About

Code review tool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published