Planner

A tool to help manage codebar.io members and events.

Getting started

First thing you will need, is to install Ruby 2.0.0

Using rvm

rvm install 2.0.0-p353

Using rbenv

rbenv install 2.0.0-p353
rbenv global 2.0.0-p353

Install the gems!

gem install bundler
bundle install --without production

You need to user the --wihout production flag to avoid requiring the pg gem, and Postgres. You don't need it anyway on development!

Setup the database

bundle exec rake db:create
bundle exec rake db:migrate db:test:prepare

Generate some data!

bundle exec rake db:seed

Run the tests

bundle exec rake

Enable GitHub authentication

Create an application at https://github.com/settings/applications/new with http://localhost:3000 as the Homepage URL and http://localhost:3000/auth/github as the Authorization callback URL.

Once you development application is setup, create a file named .env in the root of the application folder with the GitHub key and secret like so:

GITHUB_KEY=YOUR_KEY
GITHUB_SECRET=YOUR_SECRET

Find something to work on

You can pick one of the open issues, fix a bug, improve the interface, refactor the code or improve test coverage!

If there is something else that you would like to work on, open an issue first so we can discuss it. We are always open to new ideas and ways of improving planner!

Guidelines on contributing to planner

janedallaway / planner