WebSpeedReport

WebSpeedReport is an open source tool that provides more in depth information about your internet connection.

Features:
• It utilises SpeedTest from Ookla.
• Has a command that handles the database along with the created data.
• Gives you an overall view of your data in a dashboard.
• Provides an in-depth view from your internet test runs.
• New: Organises the data in Graphs.

Installation

1. SpeedTest

First of all, you need to install SpeedTest CLI from Ookla. You can find the installation instructions here.

2.Install PHP

Based on your operating system install PHP

3.Install MySql

Based on your operating system install MySQL

4. Composer

After you have installed SpeedTest CLI, you need to install Composer. You can find the installation instructions here.

5. Clone the repository

After you have installed Composer, you need to clone the repository. You can do that by running the following command in your terminal:

git clone https://github.com/bak-george/WebSpeedReport.git 

This will create a directory named WebSpeedReport containing all the repository files. Navigate into it with:

cd WebSpeedReport

6. Install dependencies

After you have cloned the repository, you need to install the dependencies. You can do that by running the following command in your terminal:

composer install

7.Provide Permissions for the executable

After you have installed the dependencies, you need to provide permissions for the executable. You can do that by running the following command in your terminal:

chmod +x ./webspeedreport

Usage

1. Run the speedtest

After you have installed the dependencies, you need to run the speedtest.

You can do that by changing the directory to WebSpeedReport and running the following command in your terminal:

cd WebSpeedReport

./webspeedreport app:speedtest

This command will also create the database and table to insert the generated data.

In order to get help for the command you can run the following command in your terminal:

./webspeedreport app:speedtest --help

2.Starting the local PHP server

In order to see your generated data you'll need to run PHP localy on your computer.

You can do that by running the following command in your terminal:

php -S localhost:8000 -t public

3.Accessing the dashboard

After you have started the local PHP server, you can access the dashboard by opening the following link in your browser:

http://localhost:8000

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Notice of Usage of Speedtest® by Ookla® in Open Source Projects

In this open source project, we incorporate the use of Speedtest CLI provided by Ookla®. We acknowledge and respect Ookla® and its contributors' rights to the Speedtest® technology.

The Speedtest CLI tool allows users to test internet performance metrics, and this is utilized in our project to provide users with insights into their internet connectivity.

Our use of Speedtest CLI is in accordance with its licensing terms. We do not claim any ownership or rights over the Speedtest technology, logo, or other related properties, and all respective rights remain with Ookla®.

All users and contributors of this open source project are advised to review Ookla's terms of service and any related licensing agreements to ensure compliance when integrating or working with Speedtest technology.

Please support the original creators by visiting Ookla's official website for Speedtest: https://www.speedtest.net/

If there are any concerns or copyright issues, please contact george_bak'at'proton.me to address them promptly.