marcosalberto/planner

A tool to help us keep organised

Planner

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

If you are considering making a PR, please take a look at the Waffle board to see if someone else has already started work on an existing issue.

Waffle board

We're on Slack!

Getting started

First thing you will need, is to install Ruby 2.2.2

Using rvm

rvm install 2.2.2

Using rbenv and ruby-build

rbenv install 2.2.2
rbenv global 2.2.2

Install the gems!

gem install bundler
bundle install --without production

Setup the database

Adjust config/database.yml as needed.

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

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 your 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

Note: Windows doesn't like creating a file named .env so do the following from a cmd prompt in your application folder:

echo GITHUB_KEY=YOUR_KEY >> .env
echo GITHUB_SECRET=YOUR_SECRET >> .env

Generate some data!

bundle exec rake db:seed

Run the tests

bundle exec rake

Note: JavaScript acceptance tests are relying on the Poltergeist driver, which requires PhantomJS. For more information about installing PhantomJS, please take a look here.

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