canyon icon indicating copy to clipboard operation
canyon copied to clipboard

👋 Canyon is a JavaScript code coverage solution

Canyon

Welcome to the Canyon codebase, we are thrilled to have you here!

What is Canyon?

Canyon is a JavaScript code coverage platform. Canyon can realize multi terminal coverage reporting and collection through babel plugin configuration.

Table of Contents

  • What is Canyon?
  • Table of Contents
  • Setup Documentation
  • Usage Documentation
  • Documentation and Other Links
  • Docker
  • Contributing
  • License

Setup Documentation

This section of the documentation will help you install and configure the Canyon Server.

Usage Documentation

Our documentation teaches you how to install the babel-plugin-canyon in a JavaScript project and report to the canyon server to view the coverage information.

Documentation and Other Links

Docker

docker run -d --name canyon -v /path/to/application.yml:/usr/src/app/conf/application.yml -p 8080:8080 zhangtao25/canyon:main

Contributing

We encourage you to contribute to Canyon! whether thats joining in on the community slack or discourse, or contributing pull requests / documentation changes or raising issues.

License

MIT

Copyright (c) 2022-present, zhangtao25