Skip to content
Endform logo Endform logo Endform docs

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

Clone our tutorial repository to get started quickly:

Terminal window
git clone git@github.com:endformdev/playwright-tutorial.git && cd playwright-tutorial
pnpm install

2. Login to Endform

Authenticate with the Endform CLI:

Terminal window
npx endform@latest login

3. Configure Playwright

The tutorial repository has webServer configured to start the dev server on port 3000:

playwright.config.ts
// Already configured in the tutorial repository
export default defineConfig({
  webServer: {
    command: 'pnpm dev',
    url: 'http://localhost:3000',
    reuseExistingServer: !process.env.CI,
  },
  use: {
    baseURL: 'http://localhost:3000',
  },
});

4. Run your tests

Execute your test suite with Endform:

Terminal window
npx endform@latest test

View your results

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