shotbro-playwright

ShotBro!

Sick of out of date screenshots in support sites and websites.

Generate them using PlayWright, upload them to ShotBro, them embed them in your docs.

Getting Started

Already use Playwright?

npm install shotbro-playwright

Add to your .gitignore:

.shotbro/

• Visit https://shotbro.io
  • Sign Up
  • Create a project
  • Go to project settings
  • Add an API key
• In your local playwright test folder
  • Add the key to:
    • SHOTBRO_APP_API_KEY environment variable in your terminal
    • or add to your .env file as:
      • SHOTBRO_API_KEY=keyGoesHere
  • See examples/playwright-v1/playwright.config.ts for how to add the shotbro-playwright reporter to your playwright config
  • Add calls to shotBroPlaywright in your tests, see examples/playwright-v1/tests/example.spec.ts.

How does it work

During your tests call shotBroPlaywright, it will save full page screenshot and HTML with positional info to disk.

When your tests complete successfully call shotBroUpload and generated shots and meta info will be uploaded for processing.

Visit your project on https://shotbro.io and see your shots.