|
1 | | -# example-playwright-typescript-ultrafastgrid |
2 | | -Applitools Example: Playwright TypeScript with the Ultrafast Grid |
| 1 | +# Applitools Tutorial: Playwright TypeScript with the Ultrafast Grid |
| 2 | + |
| 3 | +This is the example project for the [Playwright TypeScript tutorial](https://applitools.com/tutorials/playwright.html). |
| 4 | +It shows how to start automating visual tests |
| 5 | +with [Applitools Eyes](https://applitools.com/platform/eyes/) |
| 6 | +and the [Ultrafast Grid](https://applitools.com/platform/ultrafast-grid/) |
| 7 | +using [Playwright](https://playwright.dev/) in TypeScript. |
| 8 | + |
| 9 | +It uses: |
| 10 | + |
| 11 | +* [TypeScript](https://www.typescriptlang.org/) as the programming language |
| 12 | +* [Playwright](https://playwright.dev/) for browser automation |
| 13 | +* [Playwright Test](https://playwright.dev/docs/api/class-test) as the core test framework |
| 14 | +* [Chromium](https://www.chromium.org/chromium-projects/) as the local browser for testing |
| 15 | +* [npm](https://www.npmjs.com/) for dependency management |
| 16 | +* [Applitools Eyes](https://applitools.com/platform/eyes/) for visual testing |
| 17 | +* [Applitools Ultrafast Grid](https://applitools.com/platform/ultrafast-grid/) for cross-browser execution |
| 18 | + |
| 19 | +To run this example project, you'll need: |
| 20 | + |
| 21 | +1. An [Applitools account](https://auth.applitools.com/users/register), which you can register for free |
| 22 | +2. A recent version of [Node.js](https://nodejs.org/en/download/) |
| 23 | +3. A good TypeScript editor like [Visual Studio Code](https://code.visualstudio.com/docs/languages/typescript) |
| 24 | + |
| 25 | +To install dependencies and set up Playwright, run: |
| 26 | + |
| 27 | +``` |
| 28 | +npm install |
| 29 | +npx playwright install |
| 30 | +``` |
| 31 | + |
| 32 | +The main test case spec is [`acme-bank.spec.ts`](tests/acme-bank.spec.ts). |
| 33 | + |
| 34 | +To execute tests, set the `APPLITOOLS_API_KEY` environment variable |
| 35 | +to your [account's API key](https://applitools.com/tutorials/getting-started/setting-up-your-environment.html), |
| 36 | +and then run: |
| 37 | + |
| 38 | +``` |
| 39 | +npm test |
| 40 | +``` |
| 41 | + |
| 42 | +**For full instructions on running this project, take our |
| 43 | +[Playwright TypeScript tutorial](https://applitools.com/tutorials/playwright.html)!** |
0 commit comments