Information and code contained in this repository should be considered provisional and a work in progress, and not the final implementation for the HMDA Platform UI, unless otherwise indicated.
For more information on HMDA, checkout the About HMDA page on the CFPB website.
This repo contains the code for the entirety of the HMDA platform front-end, working directly with the HMDA platform back-end and the HMDA platform authentication. The various parts of the platform UI are:
All pages, expect the home page, require authentication.
/- home page- provides general information about the HMDA filing process and requirements
/institutions- institutions listing- displays all institutions for which a filer has access to file
/<institutionId>/<filingPeriod>/upload- file upload form for a specific institution and filing period/<institutionId>/<filingPeriod>/syntacticalvalidity- displays the list of all syntactical and validity edits the exist in the uploaded file/<institutionId>/<filingPeriod>/quality- displays the list of all quality edits the exist in the uploaded file and allows for verification/<institutionId>/<filingPeriod>/macro- displays the list of all macro edits the exist in the uploaded file and allows for verification/<institutionId>/<filingPeriod>/summary- displays the Institution Register Summary (IRS), the validation summary (an overall summary of the submission), and allows for signing of the submission.
We use node and yarn to manage front-end dependencies. You should have node installed as well as yarn.
See the package.json file for application dependencies.
$ git clone git@github.com:cfpb/hmda-platform-ui.git
$ cd hmda-platform-ui
$ yarnViewing the full application requires the back-end API and authentication. Please follow the instructions found under the "Building and Running" heading of the HMDA platform README. Running docker-compose from the hmda-platform repo will map a volume from the local built files into the ui's Docker container. This means local rebuilds will be instantly reflected in the running docker container.
$ npm testWe're using prettier to format all of our .js, .jsx, and .scss. We provide a prettier config and a script in package.json; which can be run using yarn run pretty. But, we recommend integrating prettier with you're favorite editor.
Just be sure to use singleQuote: true and semi: false for all .js and .jsx files and singleQuote: false and semi: true for all .scss files.
This repo is a work in progress.
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
- Projects that inspired you
- Related projects