GitHub Codespaces

GitHub Codespaces provide cloud-hosted development environments that run directly in your browser or local VS Code client.

Official Serenity/JS Docker images are fully compatible with GitHub Codespaces, and all the Serenity/JS Project Templates include a preconfigured devcontainer.json file to ensure your Codespace:

• Uses the Serenity/JS Playwright Docker image
• Installs recommended VS Code extensions
• Configures port forwarding for any Serenity/JS report servers

To launch a Codespace for any Serenity/JS project, open the repository on GitHub and select Code → Create Codespace on main.

Customising the Codespace

You can tailor the development environment by editing the .devcontainer/devcontainer.json file. This is where you can:

• Add or update Dev Container Features
• Extend the toolchain
• Adjust VS Code extensions
• Modify ports, mounts, or environment variables

Below example configuration uses the Serenity/JS Playwright Docker image and adds GitHub CLI and Light-weight Desktop features:

{ "name": "My Serenity/JS Codespace", "image": "ghcr.io/serenity-js/playwright:v1.57.0-noble", "features": { "ghcr.io/devcontainers/features/desktop-lite:1": {}, "ghcr.io/devcontainers/features/github-cli:1": {} }, "customizations": { "vscode": { "extensions": [ "dbaeumer.vscode-eslint", "editorconfig.editorconfig", "eamodio.gitlens", "ms-playwright.playwright" ] } } }

.devcontainer/devcontainer.json

Learn More

To learn more about developing with GitHub Codespaces, visit the GitHub Codespaces Documentation.

For additional configuration options, refer to the Dev Containers specification.