Run a sample Percy build: Overview

Welcome to the guide on running a sample build. Running a sample build acts as an early checkpoint for identifying errors, ensuring correct configuration and dependencies, and integrating basic testing.

This page presents a list of sample builds for supported frameworks, all of which Percy supports. Our step-by-step guide walks you through the process of getting started with Percy.

High-level steps

1. Clone an example application.
2. Make changes to observe visual differences.
3. Compare the visual changes on the Percy dashboard.

Before you begin with a guide, we recommend to read our Getting started guide.

Sample Builds for Supported Frameworks

• Ember
• Capybara
• Storybook
• Cypress
• Nightmare
• Puppeteer
• Java Selenium
• JavaScript Selenium
• .NET Selenium
• Python Selenium
• Ruby Selenium
• Playwright JS
• Protractor
• Nightwatch
• TestCafe
• WebDriverIO

Pre-Integrated Percy-Enabled Sample Applications

Looking to dive straight into the code? Check these sample applications that already have Percy integration:

• percy/example-ember
• percy/example-rails
• percy/example-storybook-for-react
• percy/example-percy-cypress
• percy/example-percy-nightmare
• percy/example-percy-puppeteer
• percy/example-percy-puppeteer-standalone
• percy/example-percy-java-selenium
• percy/example-percy-protractor
• percy/example-percy-nightwatch
• percy/example-percy-testcafe

Next Step

To set up your development environment and run the sample build, see Create a project.