🗓 the main codebar site
Clone or download
Latest commit 18f9fe4 Dec 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Merge branch 'master' into add-image-field-to-chapter Nov 30, 2018
bin add docker scripts for rails, rspec, rake May 4, 2018
config Update en_GB.yml Dec 19, 2018
db Generates migrartion to add image field to chapters Nov 18, 2018
lib (fix) fix meeting reminders rake task and test Aug 9, 2018
log let's get organised Oct 15, 2013
public added meta data and images of app icons Dec 2, 2017
spec add member controller tests for subscribe route Dec 19, 2018
vendor/assets mv start rating to assets May 1, 2014
.dockerignore Modify Dockerfile & .travis.yml to run docker-compose in CI May 4, 2018
.gitignore Add local uploads to gitignore Jun 12, 2018
.rspec rspec and haml Oct 15, 2013
.rubocop.yml Forces linux style line endings in rubocop Aug 23, 2018
.ruby-version update rails to 4.2.10 and ruby 2.4.2 Dec 4, 2017
.travis.yml Don’t use docker on travis May 6, 2018
CONTRIBUTING.md Add run rubocop to contributing.md Jan 8, 2018
Dockerfile Docker: Simplify the PhantomJS download process. May 4, 2018
Gemfile Bump rubocop from 0.59.2 to 0.61.1 Dec 10, 2018
Gemfile.lock Bump uglifier from 4.1.19 to 4.1.20 Dec 19, 2018
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md May 8, 2018
LICENSE Update copyright year Aug 24, 2018
Makefile Fix rebasing options in Makefile Dec 10, 2016
Procfile use delayed job Apr 19, 2015
README.md Remove reference to Waffle board Aug 24, 2018
Rakefile let's get organised Oct 15, 2013
config.ru Use Ruby 1.9 hash syntax Jan 11, 2018
crowdin.yml Update Crowdin configuration file Oct 2, 2018
docker-compose.env configure a docker-compose.env May 4, 2018
docker-compose.yml configure a docker-compose.env May 4, 2018

README.md

Planner

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

Build Status Coverage Status Code Climate

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!

Getting Started

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/

  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.

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.

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

Other dependencies

brew install imagemagick
brew install phantomjs

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