diff --git a/web/cashtab/README.md b/web/cashtab/README.md --- a/web/cashtab/README.md +++ b/web/cashtab/README.md @@ -9,10 +9,8 @@ ## Development -CashTab relies on some modules that retain legacy dependencies. NPM version 7 or later no longer supports automatic resolution of these peer dependencies. To successfully install modules such as `qrcode.react`, with NPM > 7, run `npm install` with the flag `--legacy-peer-deps` - ``` -npm install --legacy-peer-deps +npm install npm start ``` @@ -24,15 +22,28 @@ ## Testing -### 'npm test' +Run the tests in watch mode (interactive): + +``` +npm test +``` -### 'npm run test:coverage' +Run the tests and generate a coverage report (non-interactive): + +``` +npm run test:coverage +``` + +You can then browse the HTML coverage report by opening the +`coverage/lcov-report/index.html` file in your web browser. ## Production In the project directory, run: -### `npm run build` +``` +npm run build +``` Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.