Development.md

Development

Getting Started

1. Install nvm
2. Setup nvm

    nvm install

3. Setup all the dependencies

   npm run setup

Start Local Development Environment

npm run dev

This starts compiling and watching all the packages in the monorepo. It also starts a local dev server for the example package at http://localhost:8080.

Formatting

Check for formatting issues

npm run lint

Apply default fixes

npm run fix

Run Tests

npm run test

Unit Tests

npm run test:unit

Integration Tests

npm run test:integration

⚠️ Playwright uses the local dev server for tests which depends on port 8080 being available.

Publishing New Version

Recording A New Demo

npm run demo

⚠️ The demo conversion depends on ffmpeg being installed on your system.