Skip to main content

Getting Started with GoDiffy

Welcome to GoDiffy! This guide will help you get up and running with visual regression testing in just a few minutes.

Quick Start​

Step 1: Create Your Account​

  1. Sign up for GoDiffy - Create your free account
  2. Verify your email - Check your inbox and click the verification link
  3. Complete your profile - Add your team or project information

Step 2: Create Your First Site​

  1. Click "Create Site" in your dashboard
  2. Enter your site details:
    • Site Name: e.g., "My App"
    • URL: Your application URL (optional)
    • Description: Brief description of what you're testing
  3. Click "Create" to set up your site

Step 3: Get Your API Key​

  1. Go to Settings → API Keys
  2. Click "Generate New Key"
  3. Copy your API key - you'll need this for integrations
  4. Store it securely - treat it like a password

The easiest way to start with GoDiffy is through GitHub Actions:

  1. Add your API key to your repository secrets:

    • Go to your repo → Settings → Secrets and variables → Actions
    • Click "New repository secret"
    • Name: DIFFY_API_KEY
    • Value: Your API key from Step 3

  2. Add your site ID as another secret:

    • Name: DIFFY_SITE_ID
    • Value: Your site ID from the GoDiffy dashboard

  3. Create a workflow file .github/workflows/visual-testing.yml:

name: Visual Regression Testing

on:
  pull_request:
    branches: [ main ]

jobs:
  visual-testing:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Run GoDiffy comparison
      uses: GoDiffy/godiffy-github-actions@v1
      with:
        api-key: ${{ secrets.GODIFFY_API_KEY }}
        site-id: ${{ secrets.GODIFFY_SITE_ID }}
        capture-screenshots: true
        config-path: './godiffy.json'

Step 5: Upload Your First Images​

You can start testing immediately:

  1. Upload images via the API or GoDiffy dashboard, organized by branch/commit
  2. Compare any two folders (e.g., master vs feature branch)
  3. Review results and similarity scores in the GoDiffy dashboard

Next Steps​

Need Help?​

Common Questions​

How do I create multiple sites?​

You can create unlimited sites with our Pro and Team plans. Each site can track different applications or environments (staging, production, etc.).

Can I use Diffy with private repositories?​

Yes! Diffy supports both public and private GitHub repositories. Simply add your Diffy API key to your repository secrets.

What image formats are supported?​

Diffy supports PNG, JPEG, and WebP formats. We recommend PNG for the best visual regression testing results.

How accurate are the comparisons?​

Our SSIM algorithm achieves 95%+ accuracy for detecting meaningful visual changes while ignoring minor rendering differences.

Can I integrate with other CI/CD platforms?​

While we have native GitHub Actions support, our REST API works with any CI/CD platform including Jenkins, GitLab CI, CircleCI, and more.

What happens to my data?​

Your images and comparison data are stored securely in our cloud infrastructure with 99.9% uptime SLA. We never share your data with third parties.

Happy testing! 🚀