Skip to content
This repository

The friendly code review system.

tree: 14c9eedb8d
README.markdown

Overview

Barkeep is a fast, fun way to review code. Engineering organizations can use it to keep the bar high.

To see a video of Barkeep in action, visit getbarkeep.org.

Barkeep is standalone software that you host. Once it's set up, you can use it to track and code review any number of git repos available on the internet. It's designed to be easy to run on Ubuntu.

Getting started

Since Barkeep is a web app with dependencies like MySQL, Redis, and others, the easiest way to get it running quickly is to run it inside a virtual machine using Vagrant:

$ cd barkeep
$ script/vagrant_quick_start.rb

You will need a few dependencies (like VirtualBox) before you can set up Barkeep inside of Vagrant, but this script will help you get them. It will take a few minutes and once it's done, Barkeep will be running inside of Vagrant. You can then browse to http://localhost:8080 to play with it.

You can shut it all down later using bundle exec vagrant halt.

Once you decide to use Barkeep for your team, you should deploy it to an Ubuntu web server. See the Deploying Barkeep wiki page for more information.

Docs

See the wiki for instructions on setting up Barkeep for development, deploying it to your own server and tracking git repos with it.

Read here for a comparison of Barkeep to other code review systems.

Contributing

Barkeep was designed to be easy to hack on with Mac or Ubuntu, so feel free to dive in. You can open a ticket to suggest a new feature. If you fix a bug or implement a small feature, send us a pull request. If you want to implement a larger feature, please post a description of the feature on the mailing list beforehand so that we can be sure it's something we want to add.

Simple style guidelines: mimic the style around you, cap lines at 110 characters, and follow the usual conventions for commit messages.

Mailing list

Please file user issues as tickets here on Github.

The Barkeep developer mailing list is used for discussion around developing Barkeep. You can email the group at getbarkeep@googlegroups.com.

Credits

Barkeep was written by the following Ooyala engineers:

and with contributions from other Ooyala engineers:

and community members:

Barkeep is released under the MIT license.

Something went wrong with that request. Please try again.