Skip to content

L33tCh/speedtest-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

REST API to manage speedtest-cli data

This project's purpose is to provide a NodeJS REST API using SQLite as a database (sqlite.db) to store and retrieve speedtest-cli results.
The code is written in ES6 and uses Promises.

Installation :

  1. Clone this repository : git clone git@github.com:linosteenkamp/speedtest-api.git
  2. Then install its dependencies : npm install

Requirements :

  • Git if you want to clone this repository.
  • NodeJS to run the application.
  • Npm to install dependencies (see the full list below at "Dependencies").
  • Postman to test the API.

Getting started :

  1. Install this application (See Installation).
  2. Start the server with : node index.js
  3. Connect Postman to the API at : http://localhost:3000

Alternatively, you can use node index.js YOUR_PORT_NUMBER to start the server with a specific port.

Dependencies (installed via npm install)

  • Body-parser, a Node.js body parsing middleware.
  • Ejs embedded JavaScript templates.
  • Express, a fast and minimalist web framework for node.
  • Sqlite, a wrapper library that adds ES6 promises and SQL-based migrations API to sqlite3*.
  • Bluebird promise library.

Credits

License

This project uses the LGPL v3 License (See the LICENSE file in this repository).

About

Restfull API to store and retrieve speedtest-cli data

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 97.0%
  • Dockerfile 3.0%