Description: This application allows consumers to search complaints submitted to the CFPB by other consumers.

This application is written in JavaScript and Less within the React framework. It uses Webpack at runtime to manage module loading.

The code is written with the ES6 feature set of JavaScript. Backwards compatibility is achieved by compiling the script with Babel prior to using it within the browser.

Unit testing of the application is performed within Jest with Enzyme providing support for event testing.

npm is used to manage the build/test/deploy cycle.

The ccdb5_ui (note the underscore) directory contains a thin Django implementation that allows it to be used as a plugin for CFPB's public website.

Pre-pre-alpha

TODO

This application depends on the following third-party components:

1. Capital Framework - CFPB standard styling and controls
2. History - Integrating the address bar with the application

It also contains portions adapted from:

1. react-typeahead

Detailed instructions on how to install, configure, and get the project running are in the INSTALL document.

Please see the subsection Configuring in INSTALL

This application depends on the Public Complaints API to be available.

For local development, you will need to the following:

• Get a local version of consumerfinance.gov running
• Fill the local Elasticsearch with data
• (optional) Install the API
  • Once it is cloned, make sure the website knows the plugin is available. Look under "Loading Sibling Projects, option 2" here

To run the app in development mode:

npm start

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

Enter Control-C to exit development mode

To build the app for production to the build folder:

npm run build

It bundles React in production mode and optimizes the build for the best performance.

To launch the test runner in interactive watch/test mode:

npm test

Enter Control-C to exit interactive watch mode

TODO

The Issue Tracker contains the most up to date status of issues or bugs with this repository.

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

CONTRIBUTING.

1. TERMS
2. LICENSE
3. CFPB Source Code Policy

• https://egghead.io/lessons/javascript-redux-the-single-immutable-state-tree
• https://medium.com/lexical-labs-engineering/redux-best-practices-64d59775802e
• https://medium.com/@kylpo/redux-best-practices-eef55a20cc72
• https://github.com/markerikson/react-redux-links/blob/master/tips-and-best-practices.md
• https://getstream.io/blog/react-redux-best-practices-gotchas/
• https://tech.affirm.com/redux-patterns-and-anti-patterns-7d80ef3d53bc
• https://github.com/gaearon/redux-devtools