From 4e4d20ad31f4030871362d12c2805846c3e81895 Mon Sep 17 00:00:00 2001
From: Crazypkr1099 <nicholas.lacasse430@gmail.com>
Date: Tue, 12 Sep 2023 12:15:04 -0400
Subject: [PATCH] Update Visual Regression README File (#1689)
---
packages/desktop-client/README.md | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/packages/desktop-client/README.md b/packages/desktop-client/README.md
index 3228051f1..834b79b48 100644
--- a/packages/desktop-client/README.md
+++ b/packages/desktop-client/README.md
@@ -37,15 +37,20 @@ First start the dev server:
```sh
HTTPS=true yarn start
```
-
-Next, run the standartised docker container and launch the visual regression tests from within it.
+Next, navigate to the root of your project folder, run the standartised docker container, and launch the visual regression tests from within it.
```sh
# Run docker container
docker run --rm --network host -v $(pwd):/work/ -w /work/ -it mcr.microsoft.com/playwright:v1.37.0-jammy /bin/bash
+ # If you recieve an error such as "docker: invalid reference format", please instead use the following command:
+ docker run --rm --network host -v ${pwd}:/work/ -w /work/ -it mcr.microsoft.com/playwright:v1.37.0-jammy /bin/bash
+
# Run the VRT tests: important - they MUST be ran against a HTTPS server
E2E_START_URL=https://192.168.0.178:3001 yarn vrt
+
+ # To update snapshots, use the following command:
+ E2E_START_URL=https://192.168.0.178:3001 yarn vrt --update-snapshots
```
#### Running against a remote server
--
GitLab