Serenity/JS Project Templates

Serenity/JS Project Templates are preconfigured starter repositories combining popular Serenity/JS modules, test tools, and example scenarios. They give you a fully working foundation for both learning and real-world projects.

You can explore all official templates on GitHub: 👉 Serenity/JS Project Templates

Each template includes:

• GitHub Actions integration
• Visual Studio Code settings
• Automated reporting to GitHub Pages

Short on time?

Go to the official tutorials to see Serenity/JS in action — no local setup needed!

Getting Started with Project Templates

You can:

• clone any Serenity/JS Project Template locally
• create new GitHub repositories from it
• or run it instantly in the cloud using Serenity/JS Codespaces

Serenity/JS Codespaces

Serenity/JS Codespaces provide a complete, browser-ready development workspace hosted on GitHub.

Each Serenity/JS Project Template ships with:

• a preconfigured development container
• all required browsers, drivers, and libraries
• recommended VS Code extensions and configuration

To launch a Codespace, you only need a free GitHub account.

Web Testing

Playwright

Playwright is a modern web testing tool supporting Chromium, WebKit, and Firefox, with a dedicated test runner (Playwright Test) and strong IDE integration.

Use Serenity/JS with Playwright to test web applications, web components, and enable cross-browser engine testing.

Project Template	Features	Get Started
Serenity/JS with Playwright Test	Serenity/JS with Playwright and Playwright Test runner, universal web testing template, recommended for most projects Playwright Test; TypeScript; GitHub Codespace; GitHub Actions; Local Chrome, Firefox, and Webkit browser engines; Playwright Test reports; Serenity BDD reports	Generate new project View Code View Serenity BDD Reports View Playwright Test Reports Start GitHub Codespace
Serenity/JS with Cucumber and Playwright	Serenity/JS with Playwright and Cucumber.js test runner, great for BDD projects that rely on Cucumber to define executable specifications Cucumber, Playwright, TypeScript, GitHub Codespace, GitHub Actions, Local Chrome browser engine, Serenity BDD reports	Generate new project View Code View Serenity BDD Reports Start GitHub Codespace

WebdriverIO

WebdriverIO is a progressive automation framework for web and mobile applications, supporting local browsers, Selenium Grid, and cloud providers.

Use Serenity/JS with WebdriverIO to test web applications, hybrid/native mobile apps, or enable cross-browser and legacy browser testing.

Project Template	Features	Get Started
Serenity/JS with Cucumber.js and WebdriverIO	Cucumber.js; WebdriverIO; TypeScript; GitHub Codespace; GitHub Actions; Local Chrome browser; Serenity BDD reports	Generate new project View Code View Serenity BDD Reports Start GitHub Codespace
Serenity/JS with Jasmine and WebdriverIO	Jasmine; WebdriverIO; TypeScript; GitHub Codespace; GitHub Actions; Local Chrome browser; Serenity BDD reports	Generate new project View Code View Serenity BDD Reports Start GitHub Codespace
Serenity/JS with Mocha and WebdriverIO	Mocha; WebdriverIO; TypeScript; GitHub Codespace; GitHub Actions; Local Chrome browser; Serenity BDD reports	Generate new project View Code View Serenity BDD Reports Start GitHub Codespace

Protractor (end of life)

Protractor was an end-to-end testing framework for Angular applications.

warning

Protractor has reached its end of life. These templates serve as a reference for migrating existing Protractor projects to Playwright or WebdriverIO via Serenity/JS.

Project Template	Features	Get Started
Serenity/JS with Cucumber and Protractor	Cucumber.js; Protractor; TypeScript; GitHub Codespace; GitHub Actions; Local Chrome browser; Serenity BDD reports	Generate new project View Code View Serenity BDD Reports Start GitHub Codespace
Serenity/JS with Jasmine and Protractor	Jasmine; Protractor; TypeScript; GitHub Codespace; GitHub Actions; Local Chrome browser; Serenity BDD reports	Generate new project View Code View Serenity BDD Reports Start GitHub Codespace
Serenity/JS with Mocha and Protractor	Mocha; Protractor; TypeScript; GitHub Codespace; GitHub Actions; Local Chrome browser; Serenity BDD reports	Generate new project View Code View Serenity BDD Reports Start GitHub Codespace

Web Component Testing

Serenity/JS integrates with Playwright Component Test runner for testing React, Svelte, Vue, Lit, and Web Components in isolation.

Project Template	Features	Get Started
Serenity/JS with Playwright CT for React	Playwright Component Testing; TypeScript; GitHub Codespace; GitHub Actions; Local Chrome, Firefox, and Webkit browser engines; Playwright Test reports; Serenity BDD reports	Generate new project View Code View Serenity BDD Reports View Playwright Test Reports Start GitHub Codespace
Serenity/JS with Playwright CT for Lit/Web Components	Playwright Component Testing; TypeScript; GitHub Codespace; GitHub Actions; Local Chrome, Firefox, and Webkit browser engines; Playwright Test reports; Serenity BDD reports	Generate new project View Code View Serenity BDD Reports View Playwright Test Reports Start GitHub Codespace

REST/HTTP API Testing

Serenity/JS provides a dedicated REST API testing module for interacting with REST and HTTP-based services, either standalone or as part of blended test scenarios.

Project Template	Features	Get Started
Serenity/JS with Cucumber	REST API testing setup; Cucumber.js; TypeScript; GitHub Codespace; GitHub Actions; Serenity BDD reports	Generate new project View Code View Serenity BDD Reports Start GitHub Codespace
Serenity/JS with Mocha	REST API testing setup; Mocha; TypeScript; GitHub Codespace; GitHub Actions; Serenity BDD reports	Generate new project View Code View Serenity BDD Reports Start GitHub Codespace

---

Something not working?

Check the Troubleshooting guide for solutions to common setup issues, or ask on the Community Forum.