/hmda-platform-api-docs

API documentation for the HMDA Submission platform.

Primary LanguageJavaScriptOtherNOASSERTION

HMDA Platform Public API

This repo is for the front end public api that lives here: https://cfpb.github.io/hmda-platform/

Prerequisite

Have homebrew and ruby installed

Recommended to use rbenv and ruby-build from homebrew, and specify the ruby version in .ruby-version

brew install rbenv ruby-build
RUBY_VERSION=2.4.1
ruby-build $RUBY_VERSION $HOME/.rbenv/versions/$RUBY_VERSION

Install bundler

gem install bundler

Running locally

You can either do this locally, or with Vagrant:

# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

You can now see the docs at http://localhost:4567. Whoa! That was fast!

Build

bundle exec middleman build --clean

Publishing

  1. Edit api host variables in config.rb (bottom of file)

  2. Edit layout.erb logo image to link to root

  3. Run to publish to gh-pages branch:

./deploy.sh
  1. Copy files to hmda-platform repo in gh-pages branch

References

Slate - API Docs Generator