View the documented source code (use the top right menu).
Follow the steps below to get your environment set up.
grunt build will create a
dist directory. Copy the contents of
dist to wherever you want the app to live.
By default, this app will serve data from api.consumerfinance.gov. If you'd like to use a different endpoint, build the app with an
grunt build --endpoint=https://someotherurl.com/api/whatever/.
Running the site locally
Please use the fork and pull collaborative model.
- Install Node and Grunt
- Fork this repo to your personal GH account.
git clone email@example.com:YOUR-USERNAME/hmda-explorer.git
localhost:8000in a browser.
Only edit files in
src. When anything is changed, Grunt will lint, test, compile and build everything. Refresh
localhost:8000 to see your changes.
In lieu of a formal styleguide, take care to maintain the existing coding style.
- Add a new version to the top of
CHANGELOGwith today's date and a list of changes. Use semver.
grunt docs. This will generate some docs and run grunt-cfpb-internal.
- Push the tag to GitHub with
git push upstream --tags.
The project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.
Software source code previously released under an open source license and then modified by CFPB staff is considered a "joint work" (see 17 USC § 101); it is partially copyrighted, partially public domain, and as a whole is protected by the copyrights of the non-government authors and must be released according to the terms of the original open-source license.
For further details, please see: http://www.consumerfinance.gov/developers/sourcecodepolicy/