zokki/speed-tester
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
This repository contains a Go application that periodically tests internet speed and latency, stores the results in a database, and generates graphs to visualize performance over time.
15 Commits 1 Branch 1 Tag 169 KiB
Go 43.1%
CSS 18%
JavaScript 13.7%
TypeScript 13.2%
templ 6.1%
Other 5.9%
main
Go to file
Tim-Niclas Oelschläger 810d0f5b80
chore: 'why'-section for README
2025-02-06 23:06:30 +01:00
.vscode Initial commit 2024-11-03 15:24:42 +01:00
database feat: parsing command-line args 2024-11-06 14:33:38 +01:00
flag fix: flag parse 2024-11-06 19:49:23 +01:00
js feat: filter for specific days 2024-11-05 23:31:48 +01:00
models feat: dedicated path for each graph 2024-11-05 18:58:47 +01:00
routes feat: filter for specific days 2024-11-05 23:31:48 +01:00
view feat: filter for specific days 2024-11-05 23:31:48 +01:00
.gitignore fix: use correct module name 2024-11-05 19:03:41 +01:00
.prettierrc Initial commit 2024-11-03 15:24:42 +01:00
go.mod fix: use correct module name 2024-11-05 19:03:41 +01:00
go.sum Initial commit 2024-11-03 15:24:42 +01:00
LICENSE Initial commit 2024-11-03 15:24:42 +01:00
main.go feat: parsing command-line args 2024-11-06 14:33:38 +01:00
Makefile enhance: minify js and css before build 2024-11-06 16:54:16 +01:00
package-lock.json fix: use correct module name 2024-11-05 19:03:41 +01:00
package.json feat: added zoom to graphs 2024-11-05 18:44:21 +01:00
README.md chore: 'why'-section for README 2025-02-06 23:06:30 +01:00
tailwind.config.js Initial commit 2024-11-03 15:24:42 +01:00

README.md

Internet Speed tester

This project provides a comprehensive internet speed monitoring solution by:

  • Testing: Regularly measures download speed, upload speed, latency (ping), and packet loss using the speedtest-go library.
  • Data Storage: Saves the collected data in a chosen database for historical analysis.
  • Visualization: Generates graphs to visualize the internet performance over time, allowing you to identify periods of slowdowns or instability.
  • Web Interface: Integrates with a web interface to display the generated graphs in a browser for easy access and monitoring.

Why

Internet speed monitoring is crucial for:

  • Identifying service quality issues with your ISP
  • Detecting patterns in connection degradation
  • Having historical data to support ISP complaints
  • Understanding peak usage times and their impact
  • Ensuring you get the internet speeds you're paying for
  • Meeting German legal requirements for ISP complaints, which require documented proof of persistent connection issues

Usage

  1. Go to the releases tab
  2. download the latest version
  3. execute the binary
  4. wait for data (like 5min)
  5. open http://localhost:7331 to view graphs

Contributing

We welcome contributions from the community! If you find any issues or have improvements to suggest, feel free to open an issue.

To get started with development or contribute to the project, follow these steps:

  1. Clone the Repository:
    https

    git clone https://gitea.zokki.net/zokki/speed-tester.git


    ssh

    git clone gitea@zokki.net:zokki/speed-tester.git

  2. Install Dependencies:

    cd speed-tester
go mod download

  3. Run the Development Server:

    make live

    This will start a local development server. Open your browser and navigate to http://localhost:7331 to view the website.

License

AGPL-3.0 © Tim-Niclas Oelschläger