You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,8 @@ This application allows consumers to search complaints submitted to the CFPB by
5
5
6
6
#### Technology Stack
7
7
This application is written in JavaScript and [Less](http://lesscss.org) within
8
-
the [React](https://facebook.github.io/react/) + [Redux](http://redux.js.org/)
9
-
framework. It uses [Webpack](http://webpack.github.io/docs/) at runtime to
8
+
the [React](https://facebook.github.io/react/) + [Redux](http://redux.js.org/)
9
+
framework. It uses [Webpack](http://webpack.github.io/docs/) at runtime to
10
10
manage module loading.
11
11
12
12
The code is written with the [ES6](http://es6-features.org/) feature set
@@ -17,7 +17,7 @@ Unit testing of the application is performed within
17
17
[Jest](https://facebook.github.io/jest/) with
18
18
[Enzyme](http://airbnb.io/enzyme/index.html) providing support for event testing.
19
19
20
-
[npm](https://www.npmjs.com/) is used to manage the build/test/deploy cycle.
20
+
[yarn](https://yarnpkg.com/) is used to manage the build/test/deploy cycle.
21
21
22
22
The `ccdb5_ui` (note the underscore) directory contains a thin [Django](https://www.djangoproject.com/)
23
23
implementation that allows it to be used as a plugin for
@@ -66,7 +66,7 @@ For local development, you will need to the following:
66
66
To run the app in development mode:
67
67
68
68
```bash
69
-
npm start
69
+
yarn run start
70
70
```
71
71
72
72
Open http://localhost:3000 to view it in the browser.
@@ -82,7 +82,7 @@ Enter `Control-C` to exit development mode
82
82
To launch the JavaScript test runner in interactive watch/test mode:
83
83
84
84
```bash
85
-
npmtest
85
+
yarn runtest
86
86
```
87
87
88
88
Enter `Control-C` to exit interactive watch mode
@@ -96,11 +96,11 @@ tox
96
96
97
97
## Cypress integration tests
98
98
99
-
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 meant to be run
100
-
against a consumerfinance.gov website that has access to an Elasticsearch index of consumer complaints.
99
+
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 meant to be run
100
+
against a consumerfinance.gov website that has access to an Elasticsearch index of consumer complaints.
101
101
Tests can be run in a local environment, or they can be run against an external server.
102
102
103
-
Using a Chrome browser helps avoid some inconsistencies with Cypress's default Electron browser, which currently isn't on the latest
103
+
Using a Chrome browser helps avoid some inconsistencies with Cypress's default Electron browser, which currently isn't on the latest
104
104
version of Chrome.
105
105
106
106
Timeouts and the local `baseUrl` are set in cypress.json
@@ -132,9 +132,9 @@ yarn run cypress open --browser chrome
132
132
```
133
133
134
134
### To run against a server
135
-
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.
135
+
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.
136
136
137
-
**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.
137
+
**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.
138
138
Our internal DEV servers can be deployed with `DEBUG=True` for running Cypress tests.
0 commit comments