Mauritius Sea Cable

The aim of this project is to provide a simple graphical user interface to show the Health Status of submarine cables connected to Mauritius.

View the Live Website

This project is inspired by the beautiful website baliseacable.com

Data Source

The data source is yet to be made available. It is expected to be in the following format :

// file: all-servers.json
{
    "LION": "<SpeedtestResult>",
    "SAFE1": "<SpeedtestResult>",
    "SAFE2": "<SpeedtestResult>",
    "SAFE3": "<SpeedtestResult>",
    "MARS": "<SpeedtestResult>"
}
// Where Speedtest result has the following signature
Interface SpeedtestResult {
    "timestamp": "",
    "upload": "",
    "download": "",
    "ping": ""
}

Project setup

git clone [email protected]:reallyaditya/speedtest-mauritius.git
npm install

N.B. Make sure to clone the repo using SSH

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Python 3 Dependencies

• Official Speedtest-cli from Ookla

Setting up GitHub Repo

The JSON results obtained are synced to a GitHub repo and then fetched to display the latter. To set up the Python script to push to your GitHub repo, follow the instructions below:

• Change the speed test server codes to the ones you want in /data/servers.json

{
  "LION": { "madagascar": 7755 },
  "SAFE": { "india": 24682, "south_africa": 1285, "malaysia": 12544 },
  "MARS": { "rodrigues": 27454 }
}

• You can get a list of nearby speed test servers and their codes by running the command below:

speedtest --servers

• Having cloned the repo using SSH, change the path of the project directory accordingly in the config.json script.

{
  "projectPath": "{insert path here}"
}

• Just run the speedtest.py script to do a speed test and push the results to your GitHub repo.