Sample project to add some API tests written with Cypress
- Organize folders structure
- Create random users with faker
- Store user token
- Improve assertions
To clone and run this project, you will need:
- git (I've used version
2.34.1
while writing this doc) - Node.js (I've used version
v18.15.0
while writing this doc) - npm (I've used version
9.5.0
while writing this doc)
Note: When installing Node.js, npm is automatically installed. ๐
To install the dev dependencies, run npm install
(or npm i
for short.)
Before running the tests, some environment variables need to be set up.
Make a copy of the cypress.env.example.json
file as cypress.env.json
, and set the appropriate values for all the variables.
Note: The cypress.env.json
file is not tracked by git since it's listed in the .gitignore
file.
In this project, you can run tests in interactive and headless modes, both on desktop and tablet viewports.
Run npm test
(or npm t
for short) to run all tests in headless mode
Run npm run cy:open
to open the Cypress App to run tests in interactive mode