a88zach/beneficiary-reporting-docs

Documentation for the beneficiary reporting api

Beneficiary Reporting Documentation

Documentation for the beneficiary reporting api

Setup

1. Install RVM or Homebrew to manage your Ruby version

   • RVM (uses Homebrew internally on OSX)

   $ \curl -sSL https://get.rvm.io | bash -s stable --ruby
   $ rvm install 2.2
   $ ruby -v
   ruby 2.2.xxx
   $ which ruby
   /Users/user/.rvm/rubies/ruby-2.2.x/bin/ruby

2. Install bundler

   $ gem install bundler

3. Install Jekyll and other dependencies

   # from the root of the repository
   $ bundle install

4. Build and run the site locally in watch mode

   # from the docs directory
   bundle exec jekyll serve --watch --config _config.dev.yml

Notes

• The package.json file is only used to store the current verions of 3rd party libraries that were coppied into this project and to bring those packages down again if ever needed. npm install cannot be used when auto-publishing to github pages. This allows us to keep a simple workflow and allow editors to edit content directly in github.