From 330d050ab6a8efe00152705c67660fa8ff8ebcf8 Mon Sep 17 00:00:00 2001 From: Jeezman Date: Sat, 4 Nov 2023 03:42:17 +0100 Subject: [PATCH] feat: add test commands to README.md --- README.md | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8638030bf..829951aa8 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,36 @@ Open [http://localhost:3000](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. -### `yarn test` +### `run tests` + +Run e2e and component tests (cypress non-headless mode) like so +```bash +yarn run cy-open +``` + +Run e2e test in headless mode like so +```bash +yarn run cy-run +``` + +Run component test in headless mode like so +```bash +yarn run cy-comp +``` + +To create a test coverage report +- while running the application do +```bash +yarn run cy-run +``` + +- whithout running the application do +```bash +yarn run test-coverage +``` + +The `coverage` folder contains generated coverage report -Launches the test runner in the interactive watch mode.\ -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. ### `yarn build`