Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas-desmond committed Sep 13, 2023
1 parent 023cb74 commit c88c9f1
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,20 @@ To get started you need to follow the following steps:

### Running Cypress Tests

We use Cypress to create End-to-End and Component Test use cases. To run the tests, you'll need to do the following:
We use Cypress to create End-to-End and Component Test use cases.

**To Open the Cypress Testing Console**
1. Clone the repository
2. Run a `npm install` to install all the dependencies.
3. If you have `npm run dev` running in a different terminal, please stop before running the next command.
4. Run `npm run cypress` which will run `npm run dev and npx cypress open` in parallel.
5. Select the test you want to run from the Cypress UI.

**To Run the E2E Tests Headlessly and Locally**
1. Run `npm run dev` to start the app in localhost:3000
2. Run `npx cypress run` to run the E2E tests on your local machine
3. View the terminal output to see passing or failing tests (no browser will open)

**To Run the Component Tests Locally**
1. Run `npx cypress run --component`
2. View terminal output for passing or failing tests

1 comment on commit c88c9f1

@vercel
Copy link

@vercel vercel bot commented on c88c9f1 Sep 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.