chore: docs and minor updates
This commit is contained in:
Родитель
37cde54090
Коммит
3e667f4c29
|
@ -18,7 +18,7 @@ the "what" and "why" of data breach alerts.
|
|||
|
||||
### Requirements
|
||||
|
||||
* [Node](https://nodejs.org/) (with npm)
|
||||
* [Node](https://nodejs.org/) (with NPM): we recommend using [Node Version Manager](https://github.com/nvm-sh/nvm) to install and manage Node/NPM.
|
||||
* [Postgres](https://www.postgresql.org/)
|
||||
|
||||
### Code style
|
||||
|
@ -96,7 +96,7 @@ To create the database tables ...
|
|||
credentials:
|
||||
|
||||
```
|
||||
DATABASE_URL="postgres://<username>@localhost:<port>/blurts"
|
||||
DATABASE_URL="postgres://<username>:<password>@localhost:<port>/blurts"
|
||||
```
|
||||
|
||||
3. Run the migrations:
|
||||
|
@ -152,6 +152,8 @@ the `OAUTH_CLIENT_SECRET` value from someone in #fxmonitor-engineering.
|
|||
|
||||
The full test suite can be run via `npm test`.
|
||||
|
||||
At the beginning of a test suite run, the `test-blurts` database will be populated with test tables and seed data found in `db/seeds/`
|
||||
|
||||
At the end of a test suite run, coverage info will be sent to [Coveralls](https://coveralls.io/) to assess coverage changes and provide a neat badge. For this step to complete locally, you need a root `.coveralls.yml` which contains a token – get this from another member of the Monitor team. Alternatively, without the token you can simply ignore the `coveralls` error.
|
||||
|
||||
*TODO:* Disable Coveralls step for local testing?
|
||||
|
|
|
@ -87,6 +87,9 @@
|
|||
"lint": "npm run lint:css && npm run lint:js",
|
||||
"lint:js": "eslint .",
|
||||
"lint:css": "stylelint public/css/",
|
||||
"fix": "npm run fix:css && npm run fix:js",
|
||||
"fix:js": "eslint . --fix",
|
||||
"fix:css": "stylelint public/css/ --fix",
|
||||
"test:db:migrate": "NODE_ENV=tests knex migrate:latest --knexfile db/knexfile.js --env tests",
|
||||
"test:tests": "NODE_ENV=tests HIBP_THROTTLE_DELAY=1000 HIBP_THROTTLE_MAX_TRIES=3 jest --runInBand --coverage tests/",
|
||||
"test:coveralls": "cat ./coverage/lcov.info | coveralls",
|
||||
|
|
Загрузка…
Ссылка в новой задаче