https://github.com/efficience-it/speedtest-bundle
Bundle to add a speedtest page on your Symfony project
https://github.com/efficience-it/speedtest-bundle
php symfony
Last synced: 6 months ago
JSON representation
Bundle to add a speedtest page on your Symfony project
- Host: GitHub
- URL: https://github.com/efficience-it/speedtest-bundle
- Owner: efficience-it
- License: mit
- Created: 2022-10-13T11:33:08.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-14T09:48:42.000Z (almost 2 years ago)
- Last Synced: 2025-04-16T05:59:27.913Z (over 1 year ago)
- Topics: php, symfony
- Language: JavaScript
- Homepage:
- Size: 38.1 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Speedtest bundle
This speedtest is a Symfony-based bundle. It's an overhaul of the [LibreSpeed](https://librespeed.org/) project.
It was created by Efficience IT, a French company located in Lille.
## Installation
### Step 1: Install the bundle with Composer
Require the `efficience-it/speedtest-bundle` with [Composer](https://getcomposer.org/).
```bash
$ composer require efficience-it/speedtest-bundle
```
### Step 2: Configure the speedtest in your project
First, verify if the line below is in the `bundles.php` file. If not, copy and paste it.
```php
EfficienceIt\SpeedtestBundle\SpeedtestBundle::class => ['all' => true]
```
Second, create the `speedtest.yaml` file in the `config/routes` folder.
Copy the code below and paste it in this file.
```yaml
speedtest:
resource: '@SpeedtestBundle/Resources/config/routes.yaml'
prefix: /speedtest
```
### Step 3: Add the speedtest on your website
On any controller, you can call the SpeedtestService and its `displaySpeedtest` function.
Here is an example of a controller, with a route tht includes the bundle:
```php
class HomeController extends AbstractController
{
/**
* @Route("/home", name="app_home")
*/
public function index(SpeedtestService $speedtestService): Response
{
// Replace 'home/index.html.twig' with the name of your template
return $this->render('home/index.html.twig', [
'speedtest' => $speedtestService->displaySpeedtest()
]);
}
}
```
To display the speedtest on your page, just include it in your template file as below:
```php
{% extends 'base.html.twig' %}
{% block title %}Hello HomeController!{% endblock %}
{% block body %}
{% include speedtest %}
{% endblock %}
```
You can access to your route (in this example `localhost/home`), and the speedtest should appear !
## How to retrieve the results ?
Create a new Controller (for example `ResultsController`), and copy/paste this code:
```php
/* DON'T ADD A @Route ANNOTATION */
class ResultsController extends AbstractController
{
/* DON'T CHANGE THIS ROUTE ! */
/**
* @Route("/speedtest-results", name="speedtest_results", methods={"POST"})
*/
public function speedtestResults(Request $request): Response
{
if (!$request->isXmlHttpRequest()) {
throw new AccessDeniedException();
}
$requestContent = json_decode($request->getContent(), true);
dump($requestContent);
return new JsonResponse($requestContent);
}
}
```
With this route (called in AJAX), you can retrieve your speedtest results and do whatever you want with it !
## Change the bundle language
Find the `config/packages/translation.yaml`. You just have to change the `default_path` parameter with the language you want.
Actually, you can translate in English (en) and French (fr). Here is an example of the `translation.yaml` file with French configuration.
```yaml
framework:
default_locale: fr # Change the language here
translator:
default_path: '%kernel.project_dir%/translations'
fallbacks:
- en # Default language if the default_locale is not found.
```