NOTE: This repository has been retired. It was a previous iteration of the ShineYourEye PMO site using Jekyll to generate a static version of the site. The newer version lives in the shineyoureye-sinatra repository, so head over there to look at the current code.

ShineYourEye

This is the source code for ShineYourEye, a Parliamentary Monitoring website in Nigeria.

Installation

You'll need to have Ruby 2+ and Bundler installed on your machine before proceeding.

Get the code from GitHub

$ git clone https://github.com/theyworkforyou/shineyoureye
$ cd shineyoureye

Install the dependencies with bundler

$ bundle install

Usage

Once you've installed the code you can start a server using jekyll

$ bundle exec jekyll serve -w

This will start a webserver running at http://localhost:4000.

Deploying

This site is hosted on GitHub pages. However instead of pushing directly to the GitHub pages branch you should instead create a pull request against the master branch. When your pull request gets merged in a build will run on Travis CI, this will take the code from the master branch, build it and push it to the gh-pages branch for you. The reason for doing this is so that we can use Jekyll plugins on the site.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/theyworkforyou/shineyoureye.