# canyon

> Self-hosted, open-source JavaScript code coverage solution for per-test-case coverage during E2E and UI automation runs, with CI integration and build tool support.

- **Category:** Testing
- **Licence:** MIT
- **Latest version:** v3.0.15
- **Open source:** oss
- **Languages:** Typescript, JavaScript
- **Platforms:** Docker, Node.js
- **Tags:** Playwright, Javascript, Open Source, Testing, Self Hosted, E2e, Ci Cd, Js, Ui Automation, Coverage, Coverage Report, Unused Code, Code Coverage, E2e Testing

## Description

This platform collects JavaScript code coverage during end-to-end and UI automation test runs. It separates hit data from map data at compile time, which lets it process the large amounts of coverage data that UI tests generate. The system has three parts: plugins that add instrumentation during CI builds, a Node.js and React application that receives and processes the coverage data, and a web interface for viewing reports broken down by individual test cases. It works with popular build tools like Vite, Next.js, and Webpack, automation frameworks such as Playwright, and CI systems including GitHub Actions and GitLab CI. You can run the community edition yourself on your own hardware using Node.js 20 or later with PostgreSQL 14 or later, or by pulling the zhangtao25/canyon Docker image. The codebase is MIT licensed and receives regular updates.

## Links

- [Homepage](https://github.com/canyon-project/canyon)
- [Website](https://docs.canyonjs.io)
- [Docker](zhangtao25/canyon)
- [GitHub Repository](https://github.com/canyon-project/canyon)
- [Documentation](https://docs.canyonjs.io/docs/getting-started/introduction)
- [Docker Hub](https://hub.docker.com/r/zhangtao25/canyon)
- [FAQ](https://docs.canyonjs.io/docs/faq/common-questions)
- [Self-hosting Guide](https://docs.canyonjs.io/docs/self-host/community-edition/prerequisites)
- [GitHub Discussions](https://github.com/canyon-project/canyon/discussions)

---
Source: https://selfhost.directory/project/canyon