You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[Buildvis](https://github.com/cburgmer/buildviz), transparency for your build pipeline's results and runtime
155
-
*[HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision control and project planning tools.
156
-
*[GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD instance.
179
+
*[HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision
180
+
control and project planning tools.
181
+
*[GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD
Copy file name to clipboardExpand all lines: README.md
+65-25Lines changed: 65 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -42,19 +42,25 @@
42
42
<!-- END OF PROJECT TITLE -->
43
43
44
44
<!-- ABOUT THE PROJECT -->
45
+
45
46
## About the Project
46
-
For development teams who wants to measure their software delivery and operational (SDO) performance, this is a tool that helps them collect data from CD pipelines and visualize the key metrics in a friendly format.
47
+
48
+
For development teams who wants to measure their software delivery and operational (SDO) performance, this is a tool
49
+
that helps them collect data from CD pipelines and visualize the key metrics in a friendly format.
47
50
48
51
**The key differentiators:**
52
+
49
53
* One page configuration, quick and easy.
50
54
* The ability to work across different CD platforms.
51
-
* User can select the environment in which the analysis runs via a environment filter (Yes, production env is not the only one that matters)
55
+
* User can select the environment in which the analysis runs via a environment filter (Yes, production env is not the
56
+
only one that matters)
52
57
53
58
[Don't know what are those four key metrics?](https://www.thoughtworks.com/radar/techniques/four-key-metrics)
54
59
55
-
56
60
### Integration roadmap
61
+
57
62
List of CD tools the product supports now/plan to support
63
+
58
64
-[x] Jenkins
59
65
-[x] Bamboo
60
66
-[x] GitHub Actions
@@ -67,99 +73,132 @@ List of CD tools the product supports now/plan to support
67
73
68
74
69
75
<!-- USAGE -->
76
+
70
77
## Usage
78
+
71
79
Follow the two steps below to run the tool, and measure the four key metrics of your projects.
72
80
73
81
### Install and run
74
82
75
-
The product is released to an ECR Docker repository `public.ecr.aws/j2s5d3z8/4-key-metrics`. Please follow the steps:
83
+
The product is released to a public repository hosted on Docker Hub `docker.io/wszzwpshh1/metrik`. Please follow the
84
+
steps:
85
+
76
86
1. Ensure [Docker](https://www.docker.com) has already installed on your OS.
77
87
2. Find available [release versions](https://github.com/thoughtworks/metrik/releases) in the release page.
78
-
Or, you can find all history versions from our [image repository](https://gallery.ecr.aws/j2s5d3z8/4-key-metrics)
88
+
Or, you can find all history versions from our [image repository](https://hub.docker.com/r/wszzwpshh1/metrik)
79
89
3. Run the container locally via the following command:
90
+
80
91
```bash
81
-
docker run -d -p 80:80 --name metrik public.ecr.aws/j2s5d3z8/4-key-metrics:latest
92
+
docker run -d -p 80:80 --name metrik docker.io/wszzwpshh1/metrik:latest
82
93
```
83
-
*⚠️ We use port 80 to access the app. You may switch to any other port in case port 80 is occupied by other apps running on your machine.*
84
-
*⚠️ The `latest` tag matches the most recent version of this repository. Thus using public.ecr.aws/j2s5d3z8/4-key-metrics:latest or public.ecr.aws/j2s5d3z8/4-key-metrics will ensure you are running the most up to date version of this image.*
85
-
If you want to stick to a specific version tag, remember there no "v" in version name. e.g. public.ecr.aws/j2s5d3z8/4-key-metrics:1.1.10
86
94
95
+
*⚠️ We use port 80 to access the app. You may switch to any other port in case port 80 is occupied by other apps running
96
+
on your machine.*
97
+
*⚠️ The `latest` tag matches the most recent version of this repository. Thus using wszzwpshh1/metrik:latest or
98
+
wszzwpshh1/metrik will ensure you are running the most up to date version of this image.*
99
+
If you want to stick to a specific version tag, remember there no "v" in version name. e.g. wszzwpshh1/metrik:latest:
100
+
1.6.5
87
101
88
102
### Configure your projects
89
103
90
-
After the container is running on your machine. Go to your favourite browser and open the app. If running in local that would be `http://localhost:80/`.
104
+
After the container is running on your machine. Go to your favourite browser and open the app. If running in local that
[See our Wiki page](https://github.com/thoughtworks/metrik/wiki)
135
+
136
+
[See our Wiki page](https://github.com/thoughtworks/metrik/wiki)
115
137
<!-- END OF HOW TO COMPUTE -->
116
138
117
139
118
140
<!-- CONTRIBUTING -->
141
+
119
142
## Contributing
120
-
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
143
+
144
+
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any
145
+
contributions you make are **greatly appreciated**.
121
146
122
147
Please check our contributing guideline form [HERE](CONTRIBUTING.md)
123
148
<!-- END OF CONTRIBUTING -->
124
149
125
150
126
151
<!-- GETTING STARTED -->
152
+
127
153
## Getting Started
154
+
128
155
The codebase comprises of three major components `frontend`, `backend`, `ci`.
156
+
129
157
* Frontend app is a web application built with:
130
-
* TypeScript
131
-
* ReactJS
132
-
* ReCharts
158
+
* TypeScript
159
+
* ReactJS
160
+
* ReCharts
133
161
134
162
Go to [frontend folder](https://github.com/thoughtworks/metrik/tree/main/frontend) to find more details.
135
163
136
164
* Backend app is built with:
137
-
* Kotlin
138
-
* Spring Boot Web
139
-
* MongoDB
165
+
* Kotlin
166
+
* Spring Boot Web
167
+
* MongoDB
140
168
141
169
Go to [backend folder](https://github.com/thoughtworks/metrik/tree/main/backend) to find more details.
142
-
170
+
143
171
* Build/Package scripts lives in [ci folder](https://github.com/thoughtworks/metrik/tree/main/ci)
172
+
144
173
<!-- END OF GETTING STARTED -->
145
174
146
175
147
176
<!-- MORE -->
177
+
148
178
## More
179
+
149
180
You might also like:
181
+
150
182
*[Buildvis](https://github.com/cburgmer/buildviz), transparency for your build pipeline's results and runtime
151
-
*[HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision control and project planning tools.
152
-
*[GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD instance.
183
+
*[HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision
184
+
control and project planning tools.
185
+
*[GoCD Analytics Plugin](https://extensions-docs.gocd.org/analytics/current/), provides insights into your GoCD
186
+
instance.
187
+
153
188
<!-- END OF MORE -->
154
189
155
190
156
191
<!-- LICENSE -->
192
+
157
193
## License
158
-
Distributed under the MIT License. See [LICENSE](https://github.com/thoughtworks/metrik/blob/main/LICENSE.txt) for more information
194
+
195
+
Distributed under the MIT License. See [LICENSE](https://github.com/thoughtworks/metrik/blob/main/LICENSE.txt) for more
196
+
information
159
197
<!-- END OF LICENSE -->
160
198
161
199
162
200
<!-- CONTRIBUTORS -->
201
+
163
202
## Contributors ✨
164
203
165
204
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -228,4 +267,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
228
267
229
268
<!-- ALL-CONTRIBUTORS-LIST:END -->
230
269
231
-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
270
+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
0 commit comments