Serenity/JS

Serenity/JS is an innovative open-source framework designed to make acceptance and regression testing of complex software systems faster, more collaborative and easier to scale.

⭐️ Get started with Serenity/JS!

• Serenity/JS web testing tutorial
• Serenity/JS Handbook and Getting Started guides
• API documentation
• Serenity/JS Project Templates on GitHub

👋 Join the Serenity/JS Community!

• Meet other Serenity/JS developers and maintainers on the Serenity/JS Community chat channel
• Find answers to your Serenity/JS questions on the Serenity/JS Forum
• Learn how to contribute to Serenity/JS
• Support the project and gain access to Serenity/JS Playbooks by becoming a Serenity/JS GitHub Sponsor!

Serenity/JS Website

This repository hosts the code behind the Serenity/JS website.

The website is built with Docusaurus and uses the Docusaurus Plugin TypeDoc API to produce the API docs.

Using Gitpod virtual workspace

You can work on this repository in a virtual Gitpod workspace without having to install anything on your machine.

To do that:

• Fork this repository to your GitHub account
• Create a new branch in your forked repository
• Click on the badge in the readme of your forked repository to provision your free Gitpod workspace
• Introduce the changes you wish to propose
• Run full local build before committing - npm run build
• Commit your changes following the conventional commits standard, e.g. docs(website): fixed a typo, push them to your forked repository, and raise a Pull Requests

Note that your Gitpod workspace is configured to automatically install Node.js and all the necessary dependencies and start the local development server when you open the workspace, so you can start working on the Serenity/JS website right away!

Using your local machine

To work on the Serenity/JS website locally, you'll need to:

• Fork this repository to your GitHub account
• Clone your fork to your machine
• Make sure you have the have Node.js installed on your machine, as per the general Serenity/JS installation instructions
• Install the Node.js dependencies by running npm ci in the project root
• Make sure you can build the Serenity/JS website on your machine by running npm run build
• Start the local development server by running npm start
• Introduce the changes you wish to propose
• Run full local build before committing - npm run build
• Commit your changes following the conventional commits standard, e.g. docs(website): fixed a typo, push them to your forked repository, and raise a Pull Requests

Useful commands

Installing Node.js dependencies:

npm ci

Starting the local development server:

npm start

Running the full local build:

npm run build

📣 Stay up to date

New features, tutorials, and demos are coming soon! Follow Serenity/JS on LinkedIn, subscribe to Serenity/JS channel on YouTube and join the Serenity/JS Community Chat to stay up to date! Please also make sure to star ⭐️ Serenity/JS on GitHub to help others discover the framework!

💛 Support Serenity/JS

If you appreciate all the effort that goes into making sophisticated tools easy to work with, please support our work and become a Serenity/JS GitHub Sponsor today!