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

If you are considering making a PR, please take a look at the GitHub issues to see if there are any new feature requirements or bugs that you maybe able to help resolve.

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

You will need to have Docker installed and running - https://docker.com/

The current Dockerfile and docker-compose were closely copied from the guide: https://docs.docker.com/compose/rails/

1. Clone the project
2. Navigate in the project directory cd planner
3. Run bin/dbuild to build and setup the docker environment.
4. Run bin/drake to run all the tests and make sure everything works
5. Run bin/dstart to start the app.
6. View the app at http://localhost:3000

You can also use bin/drails and bin/drspec to run rails and rspec commands via docker.

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

rvm install 2.4.2

rbenv install 2.4.2
rbenv global 2.4.2

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

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

brew install imagemagick
brew install phantomjs

gem install bundler
bundle install --without production

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.

The application uses GitHub OAuth for user authentication.

Using these field values:

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

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

bundle exec rake db:seed

bundle exec rails server

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.

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

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