@gitmetrics/app 0.0.0-stage → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/NOTICE ADDED
@@ -0,0 +1,36 @@
1
+ GitMetrics
2
+ Copyright (C) 2026 Jean Loui Bernard Silva de Jesus (https://github.com/JeanExtreme002)
3
+
4
+ This program is free software: you can redistribute it and/or modify it under
5
+ the terms of the GNU Affero General Public License as published by the Free
6
+ Software Foundation, version 3 of the License, with the additional terms below.
7
+
8
+ This program is distributed in the hope that it will be useful, but WITHOUT
9
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
10
+ FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License in the
11
+ LICENSE file for more details.
12
+
13
+
14
+ ADDITIONAL TERMS UNDER SECTION 7 OF THE GNU AFFERO GENERAL PUBLIC LICENSE
15
+
16
+ These terms apply to every file of this program and to every work based on it.
17
+
18
+ 1. Attribution (section 7(b)). Every copy or modified version of this program,
19
+ and every network service that runs it, must keep a visible attribution to
20
+ the original author in its user interface, in its About section or an
21
+ equally easy to find place, reading:
22
+
23
+ Based on GitMetrics by Jean Loui Bernard Silva de Jesus
24
+
25
+ together with a link to https://github.com/JeanExtreme002/GitMetrics.
26
+ The copyright and attribution notices in the source code and in this file
27
+ must also be kept.
28
+
29
+ 2. Modified versions (section 7(c)). Modified versions must be marked in
30
+ reasonable ways as different from the original version, and must not be
31
+ presented as the original GitMetrics.
32
+
33
+ 3. Name and logo (section 7(e)). This license does not grant permission to use
34
+ the name "GitMetrics" or its logo, except to describe the origin of the work
35
+ as required by term 1. Modified versions distributed or offered to others
36
+ must use a different name and logo.
package/README.md CHANGED
@@ -1,3 +1,97 @@
1
- # Temporary Holding Version
1
+ <div align="center">
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ <picture>
4
+ <source media="(prefers-color-scheme: dark)" srcset="assets/logo-dark.svg" />
5
+ <img src="assets/logo-light.svg" width="96" alt="GitMetrics logo" />
6
+ </picture>
7
+
8
+ # GitMetrics
9
+
10
+ <b>Every number behind your GitHub repositories, in one dashboard.</b><br>
11
+ <i>Stars, traffic, commits, pull requests and CI health. Running on your machine, one command away.</i>
12
+
13
+ <p align="center">
14
+ <a href="https://github.com/JeanExtreme002/GitMetrics/actions/workflows/ci.yml"><img src="https://github.com/JeanExtreme002/GitMetrics/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
15
+ <a href="https://codecov.io/gh/JeanExtreme002/GitMetrics"><img src="https://codecov.io/gh/JeanExtreme002/GitMetrics/graph/badge.svg" alt="Coverage" /></a>
16
+ <a href="https://www.npmjs.com/package/@gitmetrics/app"><img src="https://img.shields.io/npm/v/@gitmetrics/app?logo=npm&color=red" alt="npm" /></a>
17
+ <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-20.19+-339933?logo=nodedotjs&logoColor=white" alt="Node Version" /></a>
18
+ <a href="#quick-start"><img src="https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-blue" alt="Platforms" /></a>
19
+ <a href="LICENSE"><img src="https://img.shields.io/badge/license-AGPL--3.0-green.svg" alt="License: AGPL-3.0" /></a>
20
+ </p>
21
+
22
+ <img src="assets/overview.png" alt="GitMetrics showing the overview of a repository" width="880" />
23
+
24
+ </div>
25
+
26
+ GitHub shows bits of your projects in scattered places, forgets older traffic and leaves the big picture to you. **GitMetrics fills those gaps** with one fast dashboard that sees everything and remembers it.
27
+
28
+ ## Quick start
29
+
30
+ You only need [Node.js](https://nodejs.org) 20.19 or newer.
31
+
32
+ ```bash
33
+ npx @gitmetrics/app
34
+ ```
35
+
36
+ Your browser opens on [http://localhost:4280](http://localhost:4280). Sign in and you are done.
37
+
38
+ **Install it globally:**
39
+
40
+ ```bash
41
+ npm install -g @gitmetrics/app
42
+ gitmetrics
43
+ ```
44
+
45
+ ## What's inside
46
+
47
+ <p align="center">
48
+ <img src="assets/pages-grid.png" alt="Stars, Commits, Pull requests and Actions pages" width="880" />
49
+ </p>
50
+
51
+ Each repository also gets **Overview**, **Traffic**, **Issues**, **Contributors**, **Hotspots**, **Releases** and **Deployments**, plus a home page across everything you own and <kbd>Ctrl</kbd> + <kbd>K</kbd> to jump anywhere. Light and dark themes included.
52
+
53
+ ## Follow how your projects grow
54
+
55
+ See where every repository is heading: stars gained, release cadence, how fast pull requests land and how healthy your CI is. Pin the projects you care about, and the home page ranks all of them by stars, activity or traffic.
56
+
57
+ ## Traffic history that never expires
58
+
59
+ GitHub keeps only the last 14 days of traffic. GitMetrics saves each window on your machine and merges it with what it saw before, so your views and clones history keeps growing for as long as you use it.
60
+
61
+ ## Signing in
62
+
63
+ **With GitHub CLI:**<br>
64
+ If you use the [GitHub CLI](https://cli.github.com), one click reuses your session.
65
+
66
+ **With a personal access token:**<br>
67
+ Paste a [token](https://github.com/settings/tokens/new?scopes=repo,read:user,read:org&description=GitMetrics) with the `repo`, `read:user` and `read:org` scopes.<br><br>
68
+
69
+ Have your own GitHub OAuth App? Set its client ID in the `GITMETRICS_CLIENT_ID` environment variable to also get a **Sign in with GitHub** button that confirms a short code in your browser.
70
+
71
+ ## Privacy
72
+
73
+ No backend, no account, no analytics. GitMetrics runs only on `127.0.0.1` and talks only to `api.github.com`. Your token, pins, cache and traffic history stay in `~/.gitmetrics`, private to you. Signing out deletes the token.
74
+
75
+ ## Options
76
+
77
+ ```text
78
+ gitmetrics [options]
79
+
80
+ -p, --port <number> Port to listen on (default: 4280)
81
+ --no-open Do not open the browser automatically
82
+ -v, --version Print the version
83
+ -h, --help Show this message
84
+ ```
85
+
86
+ **Environment variables:**
87
+
88
+ - `GITMETRICS_HOME` keeps the data somewhere other than `~/.gitmetrics`.
89
+ - `GITMETRICS_CLIENT_ID` enables **Sign in with GitHub** through your own OAuth App.
90
+
91
+ ## Contributing
92
+
93
+ Ideas, bug reports and pull requests are very welcome. [CONTRIBUTING.md](CONTRIBUTING.md) explains how to run the project locally in a couple of minutes. If GitMetrics is useful to you, a star on the repository helps other people find it.
94
+
95
+ ## License
96
+
97
+ GitMetrics is free software under the [GNU AGPL-3.0](LICENSE). Use it, change it and sell it, as long as the code stays open and the credit to the original author stays visible. The [NOTICE](NOTICE) file has the full terms.