Skip to content

Commit

Permalink
[DOCS] rewrite Cypress explanation a bit (hedyorg#3617)
Browse files Browse the repository at this point in the history
The Cypress info was placed a bit in the middle of the regular docs, this is clearer I think!
  • Loading branch information
Felienne authored Nov 11, 2022
1 parent 87dfc56 commit df4e08f
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,20 +46,6 @@ Or if you're on windows in a powershell window with py launcher installed:
(.env)> pip install -r requirements.txt
```

To install Cypress, the front-end test framework, execute the following commands:
```bash
$ cd tests
$ npm install cypress --save-dev
```

To run the tests go to `/tests/` first.
You can then the tests on the command line with the following: `npx cypress run --spec "[path to test(s)]"`
An example of running cypress: `npx cypress run --spec "cypress/e2e/login_page/*"`

If you want to connect Cypress to the online dashboard, use:

`npx cypress run --record --key <key here>`

If you want to run the website version locally, run:
```bash
(.env)$ python app.py
Expand All @@ -74,10 +60,24 @@ To run the unit tests:
(.env)$ python -m pytest
```

To run the front-end tests:
To run the front-end tests, you probably first need to install Cypress.

To install Cypress, the front-end test framework, execute the following commands:
```bash
$ cd tests
$ npm install cypress --save-dev
```

To run the tests go to `/tests/` first.
You can then the tests on the command line with the following: `npx cypress run --spec "[path to test(s)]"`
An example of running cypress: `npx cypress run --spec "cypress/e2e/login_page/*"`

If you want to connect Cypress to the online dashboard, use:

`npx cypress run --record --key <key here>`

You can also open the Cypress panel, using this in `/tests`:
```
$ npx cypress open
```

Expand Down

0 comments on commit df4e08f

Please sign in to comment.