Get started with Applitools Eyes visual testing with this example of using Storybook and our Eyes Storybook SDK.
Learn more about how to install and start this project with our Storybook tutorial!
- Install the dependencies
npm install
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.
-
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>
- macOS/Linux:
-
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 anAPPLITOOLS_SERVER_URL
environment variable. See our documentation for more information on these settings.
- Note: If you are not using the Eyes public cloud, you will need to update the
-
-
Run the example test
npx eyes-storybook
-
After the example tests complete. Visit your Applitools Eyes dashboard to view the results.
Learn more about Applitools Eyes and the Applitool Ultrafast Grid.
More about the Eyes Storybook SDK: