Skip to content

zyadhpl/velox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VELOX 🚀

Global Speed Camera Data Fetcher

Velox is a powerful tool designed to fetch, organize, and serve speed camera location data from around the world using OpenStreetMap. It includes an interactive CLI for data collection and a REST API for serving the data.


🌟 Features

  • Interactive CLI: Easy-to-use command-line interface to fetch data by continent or globally.
  • Comprehensive Coverage: Fetches speed camera data for countries across Africa, Asia, Europe, North America, Oceania, and South America.
  • REST API: Built-in Express server to serve the fetched data via simple HTTP endpoints.
  • JSON Output: All data is stored in standardized JSON format for easy integration.

🛠️ Installation

  1. Clone the repository

    git clone https://github.com/zyadhpl/velox.git
    cd velox
  2. Install dependencies

    npm install

🚀 Usage

1. Fetching Data

Velox provides an interactive CLI to download speed camera data.

node index.js
  • Select a continent to fetch data for specific countries.
  • Choose "Run All Combined" to fetch data for the entire world.
  • Data is saved in the data/ directory, organized by continent.

2. Serving Data (API)

Start the API server to access the fetched data via HTTP.

node api.js

The server will start at http://localhost:3050.

API Endpoints

  • Get Country Data

    GET /api/:code

    Replace :code with the 2-letter ISO country code (e.g., us, gb, jp).

    Example:

    curl http://localhost:3050/api/gb

📂 Project Structure

velox/
├── api.js                # Express API server
├── index.js              # Main CLI entry point
├── data/                 # Fetched data storage
│   ├── africa/
│   ├── asia/
│   └── ...
├── scripts/              # Fetching scripts per continent
└── package.json

👏 Credits & Acknowledgements

This project was made possible thanks to the following:

  • Creator: zyadhpl - For the development and maintenance of Velox.
  • Data Source: overpass.kumi.systems - A special thanks for providing the high-performance Overpass API instance used to query OpenStreetMap data.

📄 License

This project is licensed under the ISC License.

About

Velox is a high-performance data fetcher designed to retrieve speed camera locations worldwide. It features an interactive CLI for downloading data by continent and includes a built-in REST API to serve the collected datasets in JSON format.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors