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. Generate an API key

Create an API key to authenticate your CI pipeline with Endform:

Generate API Key in Dashboard →

Set this as the ENDFORM_API_KEY environment variable in your CI system.

2. Configure your CI pipeline

Add these steps to your CI configuration. Examples for popular platforms:

.gitlab-ci.yml

e2e-tests:
  image: node:20
  script:
    - npm ci
    - npx endform@latest test
  variables:
    ENDFORM_API_KEY: $ENDFORM_API_KEY
    BASE_URL: https://your-server.com

.circleci/config.yml

version: 2.1
jobs:
  e2e:
    docker:
      - image: cimg/node:20.0
    steps:
      - checkout
      - run: npm ci
      - run: npx endform@latest test
    environment:
      ENDFORM_API_KEY: $ENDFORM_API_KEY
    BASE_URL: https://your-server.com

azure-pipelines.yml

trigger:
  - main

pool:
  vmImage: 'ubuntu-latest'

steps:
  - task: NodeTool@0
    inputs:
      versionSpec: '20.x'
  - script: npm ci
    displayName: 'Install dependencies'
  - script: npx endform@latest test
    displayName: 'Run E2E tests'
    env:
      ENDFORM_API_KEY: $(ENDFORM_API_KEY)
      BASE_URL: $(BASE_URL)

bitbucket-pipelines.yml

pipelines:
  default:
    - step:
        name: E2E Tests
        image: node:20
        script:
          - npm ci
          - npx endform@latest test
        # Set ENDFORM_API_KEY in repository variables
        # Also set BASE_URL to your server URL

Make sure to set BASE_URL to your server's URL in your CI environment variables.

3. Run your pipeline

Commit and push your CI configuration. Tests will run on your next pipeline execution.

View your results

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