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.
We're on Slack!
The following steps walk through getting the application running. For contributing guidelines see here.
Getting Started With Docker
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/
- Clone the project
- Navigate in the project directory
bin/dbuildto build and setup the docker environment.
bin/draketo run all the tests and make sure everything works
bin/dstartto start the app.
- View the app at http://localhost:3000
You can also use
bin/drspec to run rails and rspec commands via docker.
Running the app on your local environment
Setting up a Ruby Environment
You will need to install Ruby 2.4.2 using RVM or rbenv.
rvm install 2.4.2
rbenv and ruby-buildUsing
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:
Homebrew on a MacUsing
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
Install the Gems!
gem install bundler bundle install --without production
Setup the Database
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:
|Authorization Callback URL||
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 (
with the GitHub key and secret like so:
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
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!