mirror of
https://github.com/henrywhitaker3/Speedtest-Tracker.git
synced 2025-12-21 13:23:04 +01:00
Update README.md
This commit is contained in:
35
README.md
35
README.md
@@ -1,6 +1,37 @@
|
||||
# Speedtest Checker
|
||||
# Speedtest Tracker
|
||||
|
||||
## Queue Setup
|
||||
This program runs a speedtest check every hour and graphs the results. The back-end is written in [Laravel](https://laravel.com/) and the front-end uses [React](https://reactjs.org/). It uses the [speedtest-cli](https://github.com/sivel/speedtest-cli) package to get the data and uses [Chart.js](https://www.chartjs.org/) to plot the results.
|
||||
|
||||

|
||||
|
||||
## Installation
|
||||
|
||||
### Installing Dependencies
|
||||
|
||||
This program has some dependencies, to install them you need to run the following:
|
||||
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install software-properties-common
|
||||
sudo add-apt [ONDREJ 7.4]
|
||||
sudo apt install php7.4 composer python3 python3-pip
|
||||
sudo pip install speedtest-cli
|
||||
```
|
||||
|
||||
Then, download the code by running:
|
||||
|
||||
```bash
|
||||
git clone [URL]
|
||||
```
|
||||
|
||||
Install the composer and npm dependencies:
|
||||
|
||||
```bash
|
||||
composer install
|
||||
npm install && npm run production
|
||||
```
|
||||
|
||||
### Queue Setup
|
||||
|
||||
`sudo apt install supervisor`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user