diff --git a/cypress/README.md b/cypress/README.md index 8c81e8b671..b4ec24a1b7 100644 --- a/cypress/README.md +++ b/cypress/README.md @@ -1,15 +1,14 @@ # boilerplate-e2e-cypress-cucumber IT4C Boilerplate for End-to-End Testing with Cypress utilizing -* [cypress-io/github-action](https://github.com/marketplace/actions/cypress-io) caching the Cypress installation and dependencies for fast Cypress CI initialisation -* [Cucumber](https://cucumber.io/docs/gherkin/reference/) for human-readable test specifications -* [Multiple Cucumber HTML Reporter](https://github.com/WasiqB/multiple-cucumber-html-reporter/tree/main) to create easy readable, and searchable HTML reports enriched with metadata +- [cypress-io/github-action](https://github.com/marketplace/actions/cypress-io) caching the Cypress installation and dependencies for fast Cypress CI initialisation +- [Cucumber](https://cucumber.io/docs/gherkin/reference/) for human-readable test specifications +- [Multiple Cucumber HTML Reporter](https://github.com/WasiqB/multiple-cucumber-html-reporter/tree/main) to create easy readable, and searchable HTML reports enriched with metadata ## Requirements and Commands Building this project requires `nodejs` (`>= v20`) and `npm`. - ### Commands | Command | Description | @@ -27,7 +26,6 @@ Building this project requires `nodejs` (`>= v20`) and `npm`. | **Maintenance** | | | `npm run update` | Check for updates | - ### Update Retrieve a list of updatable packages by running `npm run update`. @@ -40,15 +38,12 @@ npm run update -- -u npm install ``` - ## Test Examples To showcase Cucumber feature tests, a simple login example on [the-internet](https://the-internet.herokuapp.com/) is written in the feature file [Login.feature](./cypress/e2e/features/Login.feature). The `baseUrl` is set in [cypress.config.ts](https://github.com/IT4Change/boilerplate-e2e-cypress-cucumber/blob/8306614812c1011642c75ae34057ca66784cae4f/cypress.config.ts#L25) and the test steps are defined in [this step definition file](./cypress/e2e/ssteps/login.ts). - -Testing against the demo website [the-internet](https://the-internet.herokuapp.com/) was chosen from the test practice recommendations of https://www.davidmello.com/best-websites-for-practicing-test-automation/. - +Testing against the demo website [the-internet](https://the-internet.herokuapp.com/) was chosen from these [test practice recommendations](https://www.davidmello.com/best-websites-for-practicing-test-automation/). ## How to use as part of a project