Serenity/JS Website

The Serenity/JS Website repository hosts the source for serenity-js.org, including the documentation, tutorials, API reference, and community resources.
The site is built using Docusaurus, extended with the TypeDoc API plugin to generate the Serenity/JS API documentation directly from the codebase.

Getting Started

If you're new to Serenity/JS, explore:

• Tutorials
• Handbook
• API Documentation
• Project Templates

Contributing

Contributions to the Serenity/JS website are welcome.
Please read the Contributing Guide.

You can contribute using either GitHub Codespaces or your local development environment.

Using GitHub Codespaces

This repository supports GitHub Codespaces.

To start contributing instantly:

1. Fork this repository and create a new branch in your fork.
2. Open your fork in a Codespace (Code → Codespaces → Create Codespace).
3. Wait for the environment to provision and dependencies to install automatically.
4. Run a full build with:

npm run build

5. Commit your changes using conventional commit messages, e.g. docs(website): fixed a typo, then open a pull request.

You can launch a Codespace directly:

Using a Local Environment

To work on the website locally:

• Fork this repository
• Clone your fork
• Install a recent Node.js LTS version, as described in the Serenity/JS installation guide.
• Install dependencies:

npm ci

• Build the site locally:

npm run build

• Start the development server:

npm start

• Implement your changes, build again, and submit a pull request.

Useful Commands

Install dependencies:

npm ci

Run local development server:

npm start

Full production build:

npm run build

Stay Connected

Follow Serenity/JS to learn about new features, tutorials, and releases!

⭐ Star the main Serenity/JS repository to help others discover the framework!

Support Serenity/JS

Serenity/JS is maintained by a small team committed to empowering high-quality, scalable test automation. If the framework benefits your work, consider sponsoring the project:

License

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

Support ongoing development through GitHub Sponsors. Sponsors gain access to Serenity/JS Playbooks and priority help in the Discussions Forum.

For corporate sponsorship or commercial support, please contact Jan Molak.