Getting Started

Make sure to check out the requirements before you start.

Suite

Existing Suite Demo Suite

Target

Remote Server Local Server Vercel Preview Soon

Run From

Local CLI GitHub Actions Other CI/CD

1. Set up your project

Navigate to your Playwright project root:

cd your-project

2. Login to Endform

Authenticate with the Endform CLI:

npx endform@latest login

3. Configure Playwright

Configure your playwright.config.ts webServer to boot your local server:

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  webServer: {
    command: 'npm run dev',
    url: 'http://localhost:3000',
    reuseExistingServer: !process.env.CI,
  },
  use: {
    baseURL: 'http://localhost:3000',
  },
});

4. Run your tests

Execute your test suite with Endform:

npx endform@latest test

View your results

Once your tests complete, results will appear in the Endform dashboard.