Skip to content

theodi/member-directory

Repository files navigation

Member Directory

Build Status Dependency Status Coverage Status Code Climate License

The ODI's member directory frontend application.

License

This code is open source under the MIT license. See the LICENSE.md file for full details.

Setup

You need to set various environment variables. Copy env.example to .env and edit to fit your purposes.

Testing

Administration

We're using Google's OAuth2 service to authenticate admin users. You need to have an @theodi.org email address in order to gain access.

Locally, you will need to set the GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET environment variables. The details of which can be obtained from https://console.developers.google.com.

See https://github.com/zquestz/omniauth-google-oauth2#google-api-setup for more details.

Emails

If you want to test email, you can run mailcatcher before you start the app in development mode. Mail will then be delivered to a preview window running at http://localhost:1080.

Tests

The tests are made up of Cucumber features and RSpec specs.

You can run everything at once using bundle exec rake.

Or, you can run each suite individually with bundle exec cucumber or bundle exec rspec.

Vagrant

In order to run this in a production-alike Vagrant instance, you will first need to place the chef-validator.pem file into .chef/, then you can

vagrant up
vagrant ssh
cd members/
bundle --without production
rake db:migrate
rails server

then point your browser at http://33.33.33.33:3000/

This all presumes you have VirtualBox installed, of course.

Colophon

Social Media icons courtesy of https://github.com/paulrobertlloyd/socialmediaicons/. Other icons use FontAwesome: http://fortawesome.github.com/Font-Awesome/