Developer guide

Developer Guide

Thanks for dropping by and showing an interest in contributing to the project. While we are getting up and running the instructions need to be followed manually. One of our goals is for developers joining the project to be up and ready to develop within 10 minutes. Starting now...!

To run a local instance of the application:

1. Install Ruby 1.9.x http://www.ruby-lang.org/en/downloads/
2. Install Rubygems http://rubygems.org/
3. Install MongoDB http://www.mongodb.org/
4. Install Git http://git-scm.com/
5. Run Mongo
6. On the command line:

git clone git://github.com/global-pulse/oliver.git
cd oliver
gem install bundler
bundle install
rails server

To contribute code

1. Make sure you can run the application
2. Setup a GitHub account (if you don't already have one)
3. Request membership of the project team or fork your own copy
4. Sign up to an issue (or ask for one to get started)
5. Get cracking

Popular development tools for Ruby

1. RubyMine http://www.jetbrains.com/ruby/index.html
2. TextMate http://macromates.com/
3. vim http://www.vim.org/
4. emacs