Quickstart

Get up and running with Verdex in just a few minutes. This quickstart guide will walk you through the basic setup process.

Prerequisites

• Node.js 18 or later
• npm, yarn, or pnpm
• A project with automated tests (Cypress, Playwright, Selenium, or Puppeteer)

Installation

Install Verdex using your preferred package manager:

npm install verdex

Or with yarn:

yarn add verdex

Basic Configuration

Create a verdex.config.js file in your project root:

// verdex.config.js
module.exports = {
  testFramework: 'cypress', // or 'playwright', 'selenium', 'puppeteer'
  pageObjectsDir: './src/pages',
  outputDir: './src/generated',
  includeComments: true,
};

Running Verdex

Add the following script to your package.json:

"scripts": {
  "verdex:generate": "verdex generate"
}

Then run:

npm run verdex:generate