diff --git a/packages/desktop-client/README.md b/packages/desktop-client/README.md index 3228051f1d4f666fc47167bd59c122b2febbe56e..834b79b486a1f264af97ebb3436ac6248daee680 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