Documentation to support upcoming data platform API and data sets
JavaScript CSS
Switch branches/tags
Nothing to show
Pull request Compare This branch is 188 commits ahead, 66 commits behind cfpb:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_includes
_layouts
hmda
static
.bowerrc
.gitignore
.ruby-version
Gemfile
Gruntfile.js
LICENSE
README.md
_bower.json
_config.yml
bower.json
package.json

README.md

Public Data Platform

This is the documentation repository for the Public Data Platform API. It is a separate effort from Qu, the software that powers this API. That documentation lives here.

Check out the gh-pages view.

Thanks to the eregs team and their documentation work for starting us off with a great codebase.

Using JavaScript and Bower

If you are going to work on the JavaScript for this site, you need to do the following:

  • Run npm install -g bower to install Bower.
  • Run npm install -g grunt-cli to install Grunt.
  • Run npm install in the directory to install other tools.
  • Run bower install to install dependencies.

After changing the JavaScript, run grunt to rebuild the minified JS.