An open API service indexing awesome lists of open source software.

https://github.com/1ec5/sidewalk-sidekick

The hero we pedestrians need
https://github.com/1ec5/sidewalk-sidekick

Last synced: 6 months ago
JSON representation

The hero we pedestrians need

Awesome Lists containing this project

README

          

# Sidewalk Sidekick

Unnamed sidewalks got you turned around? _Never fear, for Sidewalk Sidekick is here!_

## Problem

OpenStreetMap predominantly models a sidewalk as [a distinct linear feature running parallel to the street](https://wiki.openstreetmap.org/wiki/Sidewalks#Sidewalk_as_separate_way), connecting to the street network only at each crosswalk. A standard pedestrian route generated by an OSM-based routing engine lacks enough narrative detail like street names for pedestrians to comprehend without reading the map.

## Idea

Sidewalk Sidekick demonstrates how to take a standard pedestrian route generated by Valhalla, feed its geometry back into Valhalla’s [map matching](https://valhalla.github.io/valhalla/api/map-matching/api-reference/) utility, pretending it’s a car route, then collating the names in the response with the original route’s unnamed steps, performing find and replace on individual instructions.

Ideally, Valhalla would perform `trace_route` internally and output the enriched instructions without any client intervention. Internally, Valhalla has access to much more extensive context about the routing graph and structured metadata for forming each instruction.

## Demonstration

[This demo](https://1ec5.github.io/sidewalk-sidekick/) lets you route between any two waypoints as a pedestrian. A handful of preset routes are provided for your convenience. After setting the waypoints, click Amaze Me! to see the difference between the raw and matched responses. Click on an individual instruction to focus the map on it.

The raw pedestrian route is plotted on the map in purple, marking each coordinate along the route line with a gray dot and each maneuver with a ⌘ symbol. The result of matching this route to the road network is plotted as a dashed green line. A gray strut links each coordinate along the route line with the corresponding coordinate along the matched line.

## Further reading

* Nguyen, Minh. “[Re: Don't recommend "description=... sidewalk"](https://github.com/OpenSidewalks/OpenSidewalks-Schema/issues/2#issuecomment-1074404560)”. _OpenSidewalks-Schema_. GitHub. 21 March 2022.
* Nguyen, Minh. “[Re: Announcement / request for comments: naming sidewalks in Toronto](https://community.openstreetmap.org/t/announcement-request-for-comments-naming-sidewalks-in-toronto/124205/14).” _OpenStreetMap Community Forum_. 13 January 2025.
* Nguyen, Minh. “[Route along sidewalk should name the street to follow](https://github.com/valhalla/valhalla/issues/5587)”. _Valhalla_. GitHub. 9 October 2025.
* Nguyen, Minh. “[Inferring names for sidewalks using map matching](https://community.openstreetmap.org/t/inferring-names-for-sidewalks-using-map-matching/136675)”. _OpenStreetMap Community Forum_. 9 October 2025.