Repository files navigation

This is the example project for thePlaywright TypeScript tutorial.It shows how to start automating visual testswithApplitools EyesandPlaywright in TypeScript.

It uses:

• TypeScript as the programming language
• Playwright for browser automation
• Playwright Test as the core test framework
• Chromium as the local browser for testing
• npm for dependency management
• Applitools Eyes for visual testing

It can also run tests with:

• Applitools Ultrafast Grid for cross-browser execution

To run this example project, you'll need:

1. AnApplitools account, which you can register for free
2. A recent version ofNode.js
3. A good TypeScript editor likeVisual Studio Code

Install dependencies and set up Playwright:

npm installnpx playwright install

Set theAPPLITOOLS_API_KEY environment variable to youraccount's API key. You can do this by creating a.env file in the project root:

APPLITOOLS_API_KEY=your_api_key_here

If you are using a dedicated Applitools cloud, you can also set:

APPLITOOLS_SERVER_URL=https://your-server-url.applitools.com

To run all tests:

npx playwrighttest

To run Playwright in UI mode:

npx playwrighttest --ui

The main test case spec isexample.spec.ts.By default, the project will run tests using Applitools Eyes.

Test reports are generated in theplaywright-report/ directory.

For full instructions on running this project, see thePlaywright TypeScript tutorial!