Skip to content

Commit f7e37a7

Browse files
dbfxclaude
andcommitted
feat: add README, app icon, and installer branding
- Add README.md with feature overview and all 3 screenshots - Generate multi-size app icon (SVG -> PNG/ICO) via sharp - Configure Electron Forge with icon for packager and Squirrel installer - Auto-generate icons on `npm run make` Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent f94e7e5 commit f7e37a7

File tree

14 files changed

+756
-2
lines changed

14 files changed

+756
-2
lines changed

README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Modern MTR
2+
3+
A beautiful, modern network diagnostic tool built with Electron, React, and TypeScript. Think [WinMTR](https://github.com/White-Tiger/WinMTR) but with a sleek dark UI, real-time charts, and global connectivity monitoring.
4+
5+
![Traceroute View](images/mtr.png)
6+
7+
## Features
8+
9+
- **Real-time Traceroute** — Discover network hops and continuously monitor latency, jitter, and packet loss
10+
- **Live Charts** — Latency, jitter, and packet loss visualized with interactive Recharts graphs and per-hop sparklines
11+
- **Global Target Map** — Click-to-trace from 17 AWS regions worldwide with an interactive world map
12+
- **Packet Loss Monitor** — Dashboard tracking real-time loss across 6 global endpoints
13+
- **GeoIP Lookups** — Automatic geolocation and reverse DNS for every hop
14+
- **Dark Theme** — Gorgeous dark UI with smooth Framer Motion animations
15+
16+
## Screenshots
17+
18+
### Global Target Selector
19+
Click any AWS region on the interactive map to start a trace.
20+
21+
![Global Targets](images/global-selector.png)
22+
23+
### Packet Loss Monitor
24+
Monitor real-time packet loss to endpoints across the globe.
25+
26+
![Packet Loss Monitor](images/packet-loss.png)
27+
28+
## Installation
29+
30+
Download the latest installer from [Releases](https://github.com/dbfx/modern-win-mtr/releases).
31+
32+
Or build from source:
33+
34+
```bash
35+
git clone https://github.com/dbfx/modern-win-mtr.git
36+
cd modern-win-mtr
37+
npm install
38+
npm start
39+
```
40+
41+
## Building
42+
43+
```bash
44+
# Package the app
45+
npm run package
46+
47+
# Build installers (.exe + .zip)
48+
npm run make
49+
```
50+
51+
## Release
52+
53+
This project uses [Conventional Commits](https://www.conventionalcommits.org/) and [standard-version](https://github.com/conventional-changelog/standard-version) for automated changelog generation.
54+
55+
```bash
56+
# Bump version, update CHANGELOG, tag release
57+
npm run release
58+
59+
# Push with tags — GitHub Actions builds and publishes the release
60+
git push --follow-tags origin main
61+
```
62+
63+
## Tech Stack
64+
65+
- **Electron** 40 — Desktop runtime
66+
- **React** 18 + **TypeScript** — UI framework
67+
- **Vite** — Build tooling via Electron Forge
68+
- **Tailwind CSS** — Styling
69+
- **Recharts** — Charts and data visualization
70+
- **React Simple Maps** — Interactive world map
71+
- **Framer Motion** — Animations
72+
73+
## License
74+
75+
[MIT](LICENSE)

build/icon-128.png

6.22 KB
Loading

build/icon-16.png

573 Bytes
Loading

build/icon-256.png

15 KB
Loading

build/icon-32.png

1.15 KB
Loading

build/icon-48.png

1.76 KB
Loading

build/icon-512.png

37 KB
Loading

build/icon-64.png

2.53 KB
Loading

build/icon.ico

361 KB
Binary file not shown.

build/icon.png

37 KB
Loading

0 commit comments

Comments
 (0)