Quick Start

This guide will help you get started with Inpera in just 5 minutes. We'll walk you through the essential setup steps to start using visual annotations and regression testing.

First, install the Inpera SDK in your project:

npm install @inpera/sdk

Sign up for an Inpera account and get your API key from the dashboard:

1. Go to inpera.app and create an account
2. Navigate to Settings → API Keys
3. Create a new API key
4. Copy the key (you'll need it in the next step)

Initialize Inpera in your application:

import { Inpera } from '@inpera/sdk';

const inpera = new Inpera({
  apiKey: process.env.INPERA_API_KEY,
  projectId: 'your-project-id'
});

Now you can start creating visual annotations:

// Capture a snapshot
const snapshot = await inpera.capture({
  url: 'https://your-app.com',
  name: 'Homepage'
});

// Create an annotation
await inpera.annotate({
  snapshotId: snapshot.id,
  x: 100,
  y: 200,
  comment: 'This button needs to be larger'
});

Congratulations! You've successfully set up Inpera. Here's what you can do next:

• Set up visual regression testing
• Integrate with GitHub
• Explore the API