Skip to content

sherlo-io/sherlo

Repository files navigation


Sherlo - Visual Testing for React Native Storybook

Visual Testing for React Native Storybook

npm version npm downloads license

Animated demo of Sherlo running visual regression tests on a React Native Storybook

Sherlo

Visual regression testing for React Native Storybook. Capture screenshots on iOS and Android simulators in the cloud, detect visual changes, and ship UI updates with confidence.

▶️ Sherlo in 2 minutes

How It Works

  1. 📸 Capture - Sherlo takes screenshots of your UI on iOS and Android devices in the cloud
  2. 🔍 Detect - All visual changes are automatically detected by comparison with previous versions
  3. 👍 Review - Your team reviews detected changes before they go live

Key Benefits

  • 🖼️ Pixel Perfection - Your designs, implemented exactly as intended
  • ✅ Ship with Confidence - See exactly what changed before release - no surprises in production
  • ⏱️ Minutes Not Hours - Forget device-by-device checks - every UI update caught automatically
  • 🤝 Review Together - One place where devs, designers, PMs, and QA collaborate
  • 📱 Real Mobile Testing - Native iOS & Android testing - not web approximations like React Native Web
  • ☁️ Visual Testing Cloud - You build, we test - on infrastructure built specifically for mobile UI testing

Quick Start

1) Install Sherlo

npx sherlo init

2)* Customize test devices (optional)

[
  { "id": "iphone.15", "osVersion": "17" },
  { "id": "pixel.7", "osVersion": "13", "theme": "dark" },
  { "id": "ipad.10.gen", "osVersion": "17", "locale": "en_GB", "fontScale": "+2" }
]

3) Run visual tests

npx sherlo test

🎉 That's it! Your visual testing is ready.


Full documentation →


Examples

Try Sherlo with ready-to-run example projects.

What's Inside

  • 📱 Minimal Apps - React Native + Storybook integrated with Sherlo
  • 🤖 GitHub Actions - CI/CD workflows for automated testing
  • 🔄 Different Workflows - Standard builds, OTA updates, and Expo cloud builds

Browse examples →


Review App

Review visual changes across devices in one web app as a team - from developers to designers.

Features

  • 📸 Visual Comparison - Compare before/after screenshots with highlighted changes
  • 💬 Team Feedback - Approve or reject changes and leave comments
  • 🔍 Code Inspector - Inspect React Native styles directly in the browser
  • 🎨 Figma Preview - Compare UI with Figma designs side-by-side
  • …and more

Demo of Sherlo's web application showing review workflow with visual diffs, comments, code inspection, and Figma preview

New to Storybook?

Join thousands of teams using Storybook - a tool that helps you develop and document UI components.


🧘 Build in Isolation - No need to run the full app or navigate through screens

📚 Auto Docs - Write once, get both components and documentation

💖 Perfect with Sherlo - Plug in and get iOS & Android visual tests automatically - zero extra effort


Storybook for React Native →


Join the Community

💬 Join our Discord - Get help and chat with the community

📢 Follow us on X - Latest updates and React Native tips

📧 Questions? contact@sherlo.io



⭐ Star this repo to support the project!


WebsiteAppDocsExamples