Skip to content

Files

Latest commit

d9ef29e · May 13, 2025

History

History
36 lines (25 loc) · 1.87 KB

README.md

File metadata and controls

36 lines (25 loc) · 1.87 KB

Applitools Example: WebdriverIO in JavaScript

Get started with Applitools Eyes visual testing with this example of using WDIO and our WDIO SDK.

Learn more about how to install and start this project with our WDIO tutorial!

Installation & Run

  1. Install the dependencies
    npm install
    npm install chromedriver --detect_chromedriver_version

To authenticate via the Applitools server and run tests, you need to set your API key provided from Applitools Eyes. For details on how to retrieve your API key, see the Applitools documentation.

  1. Choose one of the following options to set your API Key.

    • Set your Applitools API Key as an environment variable.

      • macOS/Linux: export APPLITOOLS_API_KEY=<Your API Key>
      • Windows: set APPLITOOLS_API_KEY=<Your API Key>
    • Set your Applitools API Key inside the applitools.config.js file via the apiKey setting.

      • Note: If you are not using the Eyes public cloud, you will need to update the serverUrl to your Eyes server URL in the applitools.config.js configuration file or set via an APPLITOOLS_SERVER_URL environment variable. See our documentation for more information on these settings.
  2. Run the example test

    npm tset
  3. After the example tests complete. Visit your Applitools Eyes dashboard to view the results.

More Information

Learn more about Applitools Eyes and the Applitool Ultrafast Grid.

More about the Eyes Storybook SDK: