A free Applitools account and Applitools API KEYTip: Unsure how to find your API key?
Read Retrieving your API key to find your API key.
Installing git is used to clone the demo project from the Github repository. Instead of installing
git, you can simply download the Zip file from the repository. Further, if you are Mac, you already have
Running the Example Project
- Clone or download the repository and navigate to that folder
Note: you can alternatively download the project as a Zip file and extract it
- Install the dependencies
- Run the example test
To run all of the tests, run:
APPLITOOLS_API_KEY="[Your API Key]" npm test
Adding Applitools Eyes to an Existing Node.js Project
Install Applitools Eyes dependencies:
npm install @applitools/eyes-images --save-dev
Download the following image and place it next your test file:
The test example currently expects the image to be placed next to it. If you prefer it to be in another location, be sure to update the location in the test.
How it works
Don't suffer in silence! Let us help you. Please reach out to us to get your project working.
Taking the next steps with Applitools
Congratulations on completing this quickstart! There's still so much to learn about visual testing with Applitools, but you're off to a great start.
Resources for next steps:
- 🤖 Learning how visual testing works
- ↔️ Setting match levels for visual checkpoints
- 💥 Troubleshooting common issues
- 🐞 Reporting bugs
- 🗺 Detailed overview of visual testing with Applitools