55 lines
1.5 KiB
Markdown
55 lines
1.5 KiB
Markdown
# 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](https://github.com/showwin/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.
|
|
|
|
## Usage
|
|
|
|
1. Go to the [releases tab](/releases/latest)
|
|
1. download the latest version
|
|
1. execute the binary
|
|
1. wait for data (like 5min)
|
|
1. 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:
|
|
</br>https
|
|
|
|
```bash
|
|
git clone https://gitea.zokki.net/zokki/speed-tester.git
|
|
```
|
|
|
|
</br>ssh
|
|
|
|
```bash
|
|
git clone gitea@zokki.net:zokki/speed-tester.git
|
|
```
|
|
|
|
1. Install Dependencies:
|
|
|
|
```bash
|
|
cd speed-tester
|
|
go mod download
|
|
```
|
|
|
|
1. Run the Development Server:
|
|
|
|
```bash
|
|
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](LICENSE) © Tim-Niclas Oelschläger
|