OSM — OpenRouteService (Study Snapshot)

Running a self-hosted OpenStreetMap routing engine locally

---

⚠️ About This Repository

This repository contains an unmodified snapshot of OpenRouteService v9.9.0 — the open-source routing engine built by GIScience / Heidelberg Institute for Geoinformation Technology.

All code here belongs to the upstream authors (see NOTICE.md and the Apache 2.0 LICENSE). This copy is kept for:

• 📖 Studying a production-grade Java/Spring Boot routing engine (graph handling, REST API design, Docker packaging)
• 🖥️ Running a local routing API on OpenStreetMap data for experiments in my other projects
• 🧪 Testing directions, isochrones, and matrix endpoints offline

Active development happens upstream — for the latest version, issues, and contributions, use GIScience/openrouteservice and the official docs.

🗺️ What Is OpenRouteService?

A highly customizable, performant routing service written in Java, built on a forked GraphHopper 4.0, consuming free geographic data from OpenStreetMap. It provides:

Service	What it gives you
Directions	Turn-by-turn routes for driving, cycling, walking, wheelchair & more
Isochrones	Areas of reachability from a location (e.g. "10 minutes away")
Matrix	Time/distance between many origin–destination pairs
Snapping	Nearest point on the road network for any coordinate
Export	The underlying routing graph per transport mode
Health / Status	Instance monitoring (self-hosted only)

🚀 Quick Start (Docker)

# Clone with LFS files (elevation data etc.)
git lfs install
git clone https://github.com/princekumar-dev/OSM.git
cd OSM

# Start the routing API
docker compose up -d

The API becomes available on http://localhost:8080/ors/v2/directions/... — see the API reference for endpoints and parameters.

📦 Large test/geometry files are tracked with Git LFS — run git lfs pull if a build complains about missing binaries.

🧱 Repository Layout (upstream)

OSM/
├── ors-api/               # REST API layer (Spring Boot)
├── ors-engine/            # Core OSM routing engine
├── ors-benchmark/         # Performance testing
├── ors-test-scenarios/    # Integration tests
├── ors-report-aggregation/
├── docs/                  # VitePress documentation site
├── Dockerfile · docker-compose.yml
└── pom.xml                # Maven build (multi-module)

🙏 Attribution

• Project: OpenRouteService by GIScience
• License: Apache License 2.0 — see NOTICE.md for third-party notices
• Data: © OpenStreetMap contributors (ODbL)

This snapshot was recorded for personal study; consider ⭐-ing the upstream repo if you find it useful.