diff --git a/README.md b/README.md index f30fb0bd..a4729492 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,8 @@ yarn dev ``` ## Documentation +- [Running visual tests](playwright/README.md) +
Release Deployment
diff --git a/playwright/README.md b/playwright/README.md new file mode 100644 index 00000000..9300d6c3 --- /dev/null +++ b/playwright/README.md @@ -0,0 +1,36 @@ +# Running Playwright Tests + +> **Note:** We run visual tests inside docker container because we need to have screenshots from linux + +## Introduction + +This guide explains how to run visual tests in Playwright using npm scripts. The scripts we will cover are: + +- `test:visual`: runs visual tests. +- `test:visual:update`: updates existing snapshots. + +## Setting Up the Environment + +Ensure you have docker + +## Docker files + +``` +/app +├── /playwright +│ ├── Dockerfile +│ └── docker-compose.yml +└── ... +``` + +## Run tests + +``` +yarn tests:visual +``` + +## Update image snapshots + +``` +yarn tests:visual:update +```