This template helps you test web applications and REST/HTTP APIs using Serenity/JS and the Playwright Test runner, with a fully configured TypeScript setup.
- Preconfigured Serenity/JS + Playwright Test + TypeScript setup
- Example web and REST API test scenarios
- Linting and CI-friendly scripts
- Ready-to-use GitHub Codespaces environment using the official Serenity/JS Docker image for quick exploration
- Integrated reporting via Serenity BDD and Playwright, with live examples:
Launch this project in an online development environment:
- Follow the Serenity/JS installation guide
- Create a new repository from this template
- Clone it to your machine
- Install dependencies:
npm ci
- Run the example tests
npm test
- View the generated reports:
- Serenity BDD:
./target/site/serenity/index.html - Playwright Test:
./playwright-report/index.html
- Serenity BDD:
- Serve the Serenity BDD report locally:
npm run start
Then open http://localhost:8080 in your browser.
If your environment requires proxy configuration or an internal registry like Artifactory or Nexus, add an .npmrc file file
with the appropriate configuration to your home directory:
proxy=http://user:[email protected]:8080/
https-proxy=http://user:[email protected]:8080/
strict-ssl=false
registry=https://artifactory.mycompany.com/artifactory/
The project provides several NPM scripts defined in package.json:
npm run lint # runs code linter
npm run lint:fix # attempts to automatically fix linting issues
npm run clean # removes reports from any previous test run
npm test # executes the example test suite
# and generates the report under ./target/site/serenity
npm start # starts a mini HTTP server and serves the test reports
# at http://localhost:8080
- Replace the sample components with your own UI elements
- Add new tasks, interactions, and assertions using Serenity/JS
- Extend the test suite or integrate it into CI/CD pipelines
- Use the sample reports to understand expected testing and reporting workflows
- API Reference
- Screenplay Pattern Guide
- Serenity/JS Project Templates
- More examples and reference implementations
- Tutorial: First Web Scenario
- Tutorial: First API Scenario
Contributions of all kinds are welcome! Get started with the Contributing Guide.
Connect with other developers using Serenity/JS:
- Updates on LinkedIn
- Community Chat
- Discussions Forum
- Explore the 💡How to... ? answers to common questions
Follow Serenity/JS to learn about new features, tutorials, and releases!
⭐ Star the main Serenity/JS repository to help others discover the framework!
The Serenity/JS code base is licensed under the Apache-2.0 license, while its documentation and the Serenity/JS Handbook are licensed under the Creative Commons BY-NC-SA 4.0 International.
See the Serenity/JS License.
Support ongoing development through GitHub Sponsors. Sponsors gain access to Serenity/JS Playbooks and priority help in the Discussions Forum.
For commercial support or corporate sponsorship, please contact Jan Molak.
