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

The following steps walk through getting the application running. For contributing guidelines see here.

Setting up a Ruby Environment

You will need to install Ruby 2.4.2 using RVM or rbenv.

Using rvm

rvm install 2.4.2

Using rbenv and ruby-build

rbenv install 2.4.2
rbenv global 2.4.2

Install and run PostgreSQL

The PostgreSQL Wiki has detailed installation guides for various platforms, but probably the simplest and most common method for Mac users is with Homebrew:

Using Homebrew on a Mac

Note: You might need to install another build of Xcode Tools (typing brew update in the terminal will prompt you to update the Xcode build tools).

brew update
brew install postgresql
brew services start postgresql

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

Note: If you are running OSX Yosemite, you may experience a problem connecting to Postgres. This stackoverflow answer might help.

Enable GitHub Authentication

The application uses GitHub OAuth for user authentication.

Create a GitHub application

Using these field values:

Field	Value
Homepage URL	http://localhost:3000
Authorization Callback URL	http://localhost:3000/auth/github

Create an application at https://github.com/settings/applications/new.

Add your application details to your environment

Create a file named .env in the root of the application folder (touch .env) 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 sample data

bundle exec rake db:seed

Run the app

bundle exec rails server

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.

Front-end framework

We use Foundation at version 5.5.3, you can find the documentation here: http://foundation.zurb.com/sites/docs/v/5.5.3/

Finding 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