Skip to content

AlexFilippov-it/wrighttest

Repository files navigation

🎭 WrightTest

Low-code UI test automation platform powered by Playwright.
Create, record, and run browser tests through a web interface - no code required.

License TypeScript Playwright Docker Stars Last Commit CI

✨ Features

  • Visual Recorder - click through your app via noVNC, steps captured automatically
  • Smart Locators - uses getByRole, getByLabel, href instead of fragile CSS paths
  • Assertions Builder - toBeVisible, toHaveText, toHaveURL and more
  • Mobile Testing - emulate iPhone 15, Pixel 7, iPad and other devices
  • Environments - {{BASE_URL}}, {{PASSWORD}} replaced at runtime per environment
  • Scheduler - cron-based automatic runs with full history per schedule
  • Suites - group tests and run them with one click or on schedule
  • Trace Viewer - built-in Playwright trace viewer after every run
  • Notifications - Telegram / Slack alerts on FAILED
  • Export - download a single .spec.ts or a runnable Playwright project .zip
  • Import - paste existing Playwright script, get a visual test
  • Dashboard - pass rate over time and flaky test detection

How WrightTest compares

Feature WrightTest Cypress Selenium IDE Playwright UI
No-code recorder βœ… ❌ βœ… ❌
Docker one-command βœ… ❌ ❌ ❌
Mobile emulation βœ… ⚠️ ❌ βœ…
Built-in scheduler βœ… ❌ ❌ ❌
Export to .spec.ts βœ… ❌ ❌ ❌
Export runnable project .zip βœ… ❌ ❌ ❌
Self-hosted βœ… βœ… βœ… ❌
Trace Viewer built-in βœ… ❌ ❌ βœ…

πŸš€ Quick Start (Docker-first)

Requirements: Docker, Docker Compose

git clone https://github.com/AlexFilippov-it/wrighttest.git
cd wrighttest

cp .env.example .env
# Edit .env - set JWT_SECRET to a long random string (required)

docker compose up --build
Service URL
App http://localhost:5173
API http://localhost:3000
noVNC http://localhost:6080

Default admin login is defined in .env:

  • ADMIN_EMAIL=admin@wrighttest.app
  • ADMIN_PASSWORD=changeme

On an empty database the seed also creates a Docker Demo project with two sample tests, a DEV environment, a Smoke Test suite, and an hourly schedule.

This path is the recommended first launch on any machine. The backend image is built on the Playwright-ready base image and includes the browser bundle, so no host browser or system library setup is required.

🌐 Live Demo

A public demo UI is available at:

Demo credentials:

  • Email: demo@wrighttest.com
  • Password: demo

The demo account has read-only access only.

πŸ–₯ Server Prerequisites

For a VPS or bare-metal deploy, make sure these are available first:

  • Docker Engine
  • Docker Compose V2 (docker compose)
  • a reverse proxy such as nginx if you want a public domain
  • free host ports for the published services if you are not proxying everything through nginx

Recommended Docker overrides for a server deploy:

  • FRONTEND_HOST_PORT
  • BACKEND_HOST_PORT
  • POSTGRES_HOST_PORT
  • REDIS_HOST_PORT
  • VNC_HOST_PORT
  • NOVNC_HOST_PORT

Keep container-internal ports unchanged; only adjust the host-facing ports and public URLs when needed.

πŸš€ Server Deployment

For a server deployment:

  1. Copy .env.example to .env
  2. Set JWT_SECRET to a long random value
  3. Set FRONTEND_URL to your public domain or reverse-proxy URL
  4. Set VITE_BACKEND_URL and VITE_NOVNC_URL to the URLs users should reach from the browser
    • local example: http://localhost:6080
    • reverse-proxy example: /vnc
  5. Adjust *_HOST_PORT values if your VPS already uses ports like 3000, 5432, or 6379
  6. Run docker compose up --build -d

If you place nginx in front of the app, proxy the public frontend domain to the frontend container and route backend/API traffic to the backend container. The backend already exposes /health and /health/db for readiness checks.

noVNC Local / Server Modes

WrightTest uses a single VITE_NOVNC_URL value and derives the websocket path from it at runtime.

Local Development

Use this when noVNC is exposed directly on localhost:

VITE_NOVNC_URL=http://localhost:6080

The recorder iframe connects to:

  • ws://localhost:6080/websockify

Server Behind Reverse Proxy

Use this when nginx exposes noVNC under a path prefix:

VITE_NOVNC_URL=/vnc

The recorder iframe connects to:

  • wss://your-domain.example/vnc/websockify

This keeps the container image unchanged and moves the deployment-specific part into configuration only.

πŸ€– AI Quick Start

If you are working with an AI coding agent, start here first:

It contains the canonical repo workflow, startup order, and environment rules for WrightTest.

πŸ›  Host Fallback (optional)

Use this only if you want to run the frontend with Vite and the backend on the host.

Requirements: Node.js 20+, PostgreSQL 16, Redis 7

git clone https://github.com/AlexFilippov-it/wrighttest.git
cd wrighttest

cp .env.example .env
# Edit DATABASE_URL for local PostgreSQL

npm install
npm run setup
cd backend && npx prisma migrate dev && npx prisma db seed && cd ..
npm run dev

npm install now runs a Playwright bootstrap step for Chromium and WebKit. On Ubuntu/Linux it will also try to install system dependencies when the terminal session allows it. If Playwright still cannot launch Chromium or mobile recording needs WebKit, run the same bootstrap manually and then install Linux deps:

npm run setup
npx playwright install chromium webkit
sudo npx playwright install-deps chromium webkit
Service URL
Frontend http://localhost:5173
Backend http://localhost:3000

If the host environment still reports missing Playwright libraries, rerun npm run setup once from the repo root. On Ubuntu/Linux this may fall back to npx playwright install-deps chromium webkit when needed.

πŸ”„ Updating

git pull
docker compose up --build -d

On first launch or after resetting volumes:

cp .env.example .env
# Make sure JWT_SECRET is set to a long random value
docker compose up --build -d

Migrations apply automatically on startup. Existing projects, tests and run history are preserved in the Postgres volume.

πŸ”§ Changing Ports

All ports are in .env - no hardcoded values in code:

BACKEND_PORT=3001
FRONTEND_PORT=8080
NOVNC_PORT=6081

Then restart:

docker compose up --build -d

πŸ“Έ Product Tour

Projects overview

Projects overview with health summaries, project status, and onboarding.

Project workspace checks tab Project alerts tab

Project workspace with checks, schedules, alerts, and operational summaries.

Check editor Global runs page

Edit browser checks visually and review global execution history across projects.

Live browser recording

Live recording captures Playwright-ready selectors directly from the browser session.

πŸ“¦ Export Playwright Project

Export a complete runnable Playwright project as a .zip archive.

The generated project includes:

  • Playwright configuration
  • ready-to-run test files
  • package.json
  • optional environment variable support
  • minimal project structure for local IDE usage

After extraction:

npm install
npx playwright install
npx playwright test

Export Playwright project

Export a runnable Playwright workspace that opens directly in your IDE and runs locally without manual setup.

πŸ‘₯ Project Roles

WrightTest supports project-level access roles to control who can edit, run, and manage a project.

Editor

Editors can:

  • create and edit checks
  • run checks
  • use recording
  • manage schedules and environments
  • export Playwright specs and projects
  • view runs, screenshots, and traces

Viewer

Viewers have read-only access.

Viewers can:

  • view checks and steps
  • inspect runs and results
  • open screenshots and traces
  • explore project structure

Viewers cannot:

  • modify checks
  • run checks
  • start recording
  • edit environments or schedules
  • manage project members

Project roles and read-only access

Project-level roles keep Viewer accounts read-only while Editors can manage checks, schedules, environments, and exports.

πŸ— Architecture

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”   POST /recordings/start   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  noVNC      β”‚ ─────────────────────────▢ β”‚ playwright codegenβ”‚
β”‚  (iframe)   β”‚ ◀──── sessionId ─────────  β”‚ headed browser   β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜                            β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
      β”‚ clicks recorded as Steps
      β–Ό
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”   POST /tests/:id/run      β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ Step Editor β”‚ ─────────────────────────▢ β”‚ BullMQ + Redis   β”‚
β”‚ + Validate  β”‚                            β”‚ Worker queue     β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜                            β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
      β”‚
Playwright headless
      β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”   polling GET /runs/:id    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ Run Result  β”‚ ◀───────────────────────── β”‚ Screenshots      β”‚
β”‚ Trace Viewerβ”‚                            β”‚ Traces           β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜                            β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

πŸ“¦ Stack

Layer Technology
Frontend React + TypeScript + Vite + Ant Design
Backend Node.js + Fastify + TypeScript
ORM Prisma + PostgreSQL
Queue BullMQ + Redis
Runner Playwright (Chromium)
VNC noVNC + Xvfb + x11vnc
Auth JWT + bcrypt
Container Docker Compose

πŸ“‹ Roadmap

  • Network mocking (page.route())
  • CLI tool (wrighttest run --project-id)
  • Export full Playwright project
  • Test-to-Doc export
  • Allure / TestIT integration

πŸ“¦ Docker Image

The Docker image badge will be added after the first public image publish.

πŸ“„ License

WrightTest is source-available, but not open-source under the OSI definition.

You may use, copy, modify, and run WrightTest for personal, educational, research, internal, and evaluation purposes, including testing your own applications, websites, services, or products.

You may not sell WrightTest as a standalone product or offer WrightTest, or a modified version of WrightTest, as a public hosted service without prior written permission.

See LICENSE for details.

About

Low-code UI test automation powered by Playwright. No-code recorder, mobile testing, Docker.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors