Setting up Barkeep for development

Mac OS

This is how it works on our Mac OS dev laptops; YMMV.

Ruby

First, ensure you've installed rbenv and Ruby 1.9.3-p194. (You can get this by installing ruby-build and running rbenv install 1.9.3-p194). Set up your 1.9.3-p194 with your Macports SSL if you've installed openssl through Macports:

CONFIGURE_OPTS="--with-openssl-dir=/opt/local" rbenv install 1.9.3-p194

You can use RVM for your local development if you prefer:

rvm install ruby-1.9.3-p194

MySQL

Barkeep uses MySQL; you will need that installed and running. You can edit the MySQL credentials Barkeep uses in environment.rb. An easy way to install MySQL is through MySQL's downloads site. Be sure to get the 64-bit version if you're running on a 64-bit CPU.

Redis

Barkeep uses Redis to cache some kinds of data. Install that with Macports:

$ sudo port install redis

or with Homebrew:

$ brew install redis

Node.js

Nodejs is not required for running Barkeep, but it is required if you want to run the unit tests.

$ port install nodejs # or brew install node
# Note: you may need to "port deactivate c-ares" before installing nodejs if you're using macports

Install gems

$ gem install bundler
$ ./script/initial_app_setup.rb

You're ready. Head on over to Running Barkeep locally.

Linux (Ubuntu)

Ruby

Install rbenv and then Ruby 1.9.3-p194.

$ sudo apt-get update
$ sudo apt-get install -y mysql-server mysql-client libmysqlclient-dev openssl libopenssl-ruby \
  libssl-dev redis-server build-essential libxslt-dev libxml2-dev

MySQL

Barkeep uses MySQL; you will need that installed and running. You can edit the MySQL credentials Barkeep uses in environment.rb.

Git

You'll need a recent version of git (1.7.6+), so install it from the PPA:

$ sudo apt-get install python-software-properties
$ sudo add-apt-repository ppa:git-core/ppa
$ sudo apt-get update
$ sudo apt-get install -y git

Install gems

$ gem install bundler
$ ./script/initial_app_setup.rb

You're ready. Head on over to Running Barkeep locally.