Percy Developer Hub

Welcome to the Percy Developer Hub. You'll find comprehensive guides and documentation to help you start working with Percy as quickly as possible, as well as support if you get stuck. Let's jump right in!

End-to-end testing

đź‘Ť

Covered in this doc

Why visual testing for end-to-end testing frameworks
How to get started with Percy for end-to-end testing frameworks
Supported end-to-end testing framework SDKs

End-to-end testing frameworks are a powerful way to ensure that all moving parts within an application are configured correctly, and that the application's is functionally working correctly.

Percy integrates easily with end-to-end tests, adding an additional layer on top of those tests to ensure that everything always looks visually as intended.

Our Puppeteer SDK also provides a lightweight mechanism to simply visit URLs and add Percy snapshots—no existing tests needed.

Note: If you're not ready to integrate Percy into your testing framework, we recommend checking out our 2-minute example app tutorials.

How it works


At a high level, integrating Percy into your end-to-end testing framework is done in three steps.

Step 1: Install one of our SDKs into your test framework
Step 2: Add snapshots to your tests where you want visual coverage
Step 3: Configure and run visual snapshots as part of your workflow

End-to-end testing SDKs


Our SDK documentation will walk you through setting up and configuring the SDK for your testing framework.

Don't see your testing framework listed? We also have support for several web application frameworks, component libraries, a command-line client, and support for building your own SDK.

If you're still not sure where to start, feel free to reach out to support.

Updated 9 months ago


What's next

Percy is designed to integrate with your tests and CI environment, but you can also run Percy locally and may find it helpful to do so while you’re first getting started.

CI setup
Running locally

End-to-end testing


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.