Skip to main content

Install & first run

This walkthrough takes you from a fresh clone to a passing test run in four steps. All commands are host-agnostic — you run them in your terminal, not inside an AI tool.

Step 1 — Install dependencies​

pnpm install

Corepack ensures the pinned pnpm version is used. After this completes you will have Docusaurus, Playwright, and all test utilities installed.

Step 2 — Install the browser​

pnpm exec playwright install chrome

This downloads the Playwright-managed version of Chrome that the test runner uses. On Linux or CI, replace chrome with chromium and set PW_CHANNEL=chromium in your environment.

Step 3 — Configure credentials​

cp .env.sample .env

Open .env in your editor and fill in:

TEST_USERNAME=your.email@example.com
TEST_PASSWORD=yourpassword

These credentials are used to log in to the PACE application before each test. Everything else — project IDs, estimate names, and similar data — lives in tests/data/*.jsonc and is already configured for the dev2 environment.

Step 4 — Run the tests​

pnpm run test

This runs the full suite against the dev2 environment (the default). You should see Playwright open Chrome and run through the test steps, then print a summary.

Useful variations​

Watch the browser — by default Playwright runs headless (no visible window). To see the browser:

HEADLESS=false pnpm run test

Target a different environment — switch from dev2 to another environment with the TEST_ENV variable:

TEST_ENV=qa2 pnpm run test

Open the HTML report — after a run, view a detailed breakdown of passes, failures, and traces:

pnpm run report

The report opens in your browser and shows screenshots, step timings, and network activity for each test.

Now that the suite is running, the next step is to author your own test. Head to Authoring from a recording for the quickest path from a screen recording to a passing spec.