Kickstart your web application acceptance testing with Serenity/JS, Cucumber, and WebdriverIO using this template repository.
Learn more about Serenity/JS: Serenity/JS and WebdriverIO guide
This repository is a GitHub template. Use it to create a new GitHub repository for your project.
If you prefer to work in a virtual environment, you can launch this repository in a Gitpod workspace.
Install the required tools:
Follow the installation guide to verify your setup.
Clone the project and run:
npm ci
This installs dependencies, including the Serenity BDD CLI.
Use the predefined NPM scripts defined in package.json to run your tests
and related tasks:
npm test # Run tests and generate reports
npm start # Serve test reports at http://localhost:8080
npm run lint # Run code linter
npm run lint:fix # Try to automatically fix linting issues
npm run clean # Remove test reports from any previous test run
Test scenarios are located in the ./test/specs directory.
Modify the examples or write your own scenarios using the Serenity/JS Screenplay Pattern.
- All automation tools ready to go: Start testing immediately with WebdriverIO, Serenity/JS and Mocha already integrated and configured.
- Serenity BDD Reports: Serenity BDD reporter pre-configured with reports available at
./target/site/serenity- Published Reports: Reports for this repository are published to GitHub Pages and available at https://serenity-js.github.io/serenity-js-cucumber-webdriverio-template/.
- Screenplay Pattern: Out-of-the-box integration with the Serenity/JS actors and Screenplay Pattern APIs
- GitHub Actions: Continuous Integration setup included
- VS Code: Pre-configured for a seamless developer experience
If you're behind a proxy or use an internal registry, configure an .npmrc file in 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/
- Serenity/JS WebdriverIO integration guide - Integrate Serenity/JS with your WebdriverIO test suite, enable Serenity BDD reports, and start using the Screenplay Pattern
- Serenity/JS Handbook - Write high-quality automated acceptance tests with Serenity/JS
- Serenity/JS API documentation - Explore Serenity/JS modules and features
- Serenity/JS Project Templates - Kickstart your projects with best practices built right in
- Serenity/JS Community chat channel - Meet Serenity/JS developers and maintainers
- Serenity/JS Forum - Find answers to your Serenity/JS questions
- Contribute to Serenity/JS - Learn how to propose features, report bugs, and contribute to the Serenity/JS codebase
- Serenity/JS on YouTube - Subscribe for tutorials, demos, conference talks, and more
- Serenity/JS on LinkedIn - Follow for release and community event announcements
- Serenity/JS on GitHub - Star Serenity/JS to help others discover the framework!
Support our mission to make test automation collaborative and easier to scale. Become a Serenity/JS GitHub Sponsor today!
