thoughtworks / metrik

An easy-to-use, cross-platform measurement tool that pulls data out of CD pipelines and analysis the four key metrics for you.
MIT License
354 stars 87 forks source link

Integrating metrik into a real-world project #133

Open simonboland opened 1 year ago

simonboland commented 1 year ago

Describe the context of this enhancement This request relates to documentation and the ability to guide a user on how to integrate metrik in an existing application. As a technical lead, I would like to integrate metrik with a real-world full-stack application, however, I don't have enough documentation showing how to do it.

Describe the solution you'd like Ideally the solution shall provide an example with a full-stack application with GitHub as the source control and any cloud provider such as AWS. The documentation shall show how to integrate with metrik and provide examples show the various metrics such as deployment frequency, lead time etc.

Additional context The idea would be to build up something similar to the Cypress Real World app https://github.com/cypress-io/cypress-realworld-app which in that case provides examples on how to integrate with different auth providers.