@cfpb/ccdb5-ui 2.4.5

package/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

package/README.md

@@ -0,0 +1,170 @@
+# Consumer Complaint Database - 5.0
+
+**Description**:
+This application allows consumers to search complaints submitted to the CFPB by other consumers.
+
+#### Technology Stack
+This application is written in JavaScript and [Less](http://lesscss.org) within
+the [React](https://facebook.github.io/react/) + [Redux](http://redux.js.org/)
+framework.  It uses [Webpack](http://webpack.github.io/docs/) at runtime to
+manage module loading.
+
+The code is written with the [ES6](http://es6-features.org/) feature set
+of JavaScript. Backwards compatibility is achieved by compiling the script with
+[Babel](https://babeljs.io/) prior to using it within the browser.
+
+Unit testing of the application is performed within
+[Jest](https://facebook.github.io/jest/) with
+[Enzyme](http://airbnb.io/enzyme/index.html) providing support for event testing.
+
+[yarn](https://yarnpkg.com/) is used to manage the build/test/deploy cycle.
+
+The `ccdb5_ui` (note the underscore) directory contains a thin [Django](https://www.djangoproject.com/)
+implementation that allows it to be used as a plugin for
+[CFPB's public website](https://github.com/cfpb/consumerfinance.gov).
+
+#### Screenshot
+![screen August 17, 2017](documentation/screenshot.png)
+
+## Dependencies
+
+This application depends on the following third-party components:
+
+1. [Capital Framework](https://cfpb.github.io/capital-framework/) - CFPB standard styling and controls
+1. [History](https://github.com/reacttraining/history) - Integrating the address bar with the application
+1. [moment](https://momentjs.com/) - Better date handling than native JavaScript
+
+It also contains portions adapted from:
+
+1. [react-typeahead](https://github.com/fmoo/react-typeahead)
+
+## Installation
+
+Instructions on how to install, configure, and get the project running
+are in the [INSTALL](INSTALL.md) document.
+
+## Configuration
+
+Please see the subsection Configuring in [INSTALL](INSTALL.md#configuring)
+
+## Usage
+
+#### Developing code
+
+###### Prerequisites
+This application depends on the [Public Complaints API](https://github.com/cfpb/ccdb5-api)
+to be available.
+
+For local development, you will need to the following:
+* [Get a local version of consumerfinance.gov running](https://github.com/cfpb/consumerfinance.gov#quickstart)
+* [Fill the local Elasticsearch with data](https://github.com/cfpb/ccdb-data-pipeline)
+* _(optional)_ [Install the API](https://github.com/cfpb/ccdb5-api)
+  * Once it is cloned, make sure the website knows the plugin is available. Look under "Loading Sibling Projects, option 2" [here](https://cfpb.github.io/consumerfinance.gov/development-tips/)
+
+###### Code-Build cycle
+
+To run the app in development mode:
+
+```bash
+yarn run 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
+
+## How to test the software
+
+#### Unit testing
+To launch the JavaScript test runner in interactive watch/test mode:
+
+```bash
+yarn run test
+```
+
+Enter `Control-C` to exit interactive watch mode
+
+To run the Python unit tests, first install [Tox](https://tox.readthedocs.io/en/latest/),
+and then run:
+
+```bash
+tox
+```
+
+## Cypress integration tests
+
+Our browser-based tests check base-line user operations for [consumer complaint search](https://www.consumerfinance.gov/data-research/consumer-complaints/search/). The tests are run against JSON fixtures from the [ccdb5-api](https://github.com/cfpb/ccdb5-api).
+
+Using a Chrome browser helps avoid some inconsistencies with Cypress's default Electron browser, which currently isn't on the latest
+version of Chrome.
+
+Timeouts and the local `baseUrl` are set in cypress.json
+
+### To run Cypress tests locally
+
+- Set your node env to development:
+```bash
+export NODE_ENV=development
+```
+You can run the tests in headless mode and just see results, or you can open the Cypress test-runner, which lets you choose tests and watch them run in a Chrome browser. Having the live browser allows you to see page state during tests, and you can open Chrome dev tools to check console errors and network requests.
+
+To run local tests and just see results:
+
+```bash
+yarn run cypress run --browser chrome --headless
+```
+
+This will run Cypress against a local version of consumerfinance.gov running on port 8000. To use a different port, such as the port 3000 used by `yarn run start`, pass a `--baseUrl` parameter:
+
+```bash
+yarn run cypress run --browser chrome --headless --config baseUrl=http://localhost:3000/data-research/consumer-complaints/search/
+```
+
+To open a local Cypress test-runner to choose which tests to run and see the browser interactions:
+
+```bash
+yarn run cypress open --browser chrome
+```
+
+### To run against a server
+You can also run Cypress tests against a server by passing a `baseUrl` config with the path to the server's consumer complaints search page.
+
+**Note**: If you run against a server that has Django's `DEBUG=False` setting, the tests will probably run into API throttling, which will make tests fail.
+Our internal DEV servers can be deployed with `DEBUG=True` for running Cypress tests.
+
+```bash
+yarn run cypress run --browser chrome --headless --config baseUrl=https://[DEV SERVER URL]/data-research/consumer-complaints/search/
+```
+
+## Getting help
+
+If you have questions, concerns, bug reports, etc, please file an issue in this
+repository's [Issue Tracker](https://github.com/cfpb/ccdb5-ui/issues).
+
+## Getting involved
+
+[CONTRIBUTING](CONTRIBUTING.md).
+
+----
+
+## Open source licensing info
+1. [TERMS](TERMS.md)
+2. [LICENSE](LICENSE)
+3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)
+
+
+----
+
+## Links that were helpful
+
+#### React-Redux
+* 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/main/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