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

https://github.com/tamcore/reststop-navigator


https://github.com/tamcore/reststop-navigator

Last synced: 20 days ago
JSON representation

Awesome Lists containing this project

README

          

# Reststop Navigator

[![Tests](https://github.com/tamcore/reststop-navigator/actions/workflows/test.yaml/badge.svg)](https://github.com/tamcore/reststop-navigator/actions/workflows/test.yaml) [![E2E](https://github.com/tamcore/reststop-navigator/actions/workflows/e2e.yaml/badge.svg)](https://github.com/tamcore/reststop-navigator/actions/workflows/e2e.yaml) [![Go](https://img.shields.io/github/go-mod/go-version/tamcore/reststop-navigator)](https://github.com/tamcore/reststop-navigator/blob/master/go.mod)

A PWA that, given your live GPS, identifies which highway and direction you're driving and lists the upcoming rest stops — filterable by fuel, EV charging, food, toilets, 24/7 opening, and dog-friendliness.

When you've picked one, the detail page hands off to Google Maps, Apple Maps, or Waze with the rest stop as a destination.

No GPS? Click **Demo mode** in the footer to explore the app with a fixed A3 Frankfurt → Hanau fixture — same as the screenshots above.


Upcoming rest stops along the route, filterable by amenity
 
Rest-stop detail with live map, distance, ETA, and Google/Apple/Waze handoff

## Coverage

MVP supports motorways and trunk roads in:

- Germany
- Austria
- Slovakia
- Czechia

## Architecture

- **Backend:** Go (chi router), Redis cache.
- **Frontend:** SvelteKit PWA, embedded into the Go binary.
- **Data:** OpenStreetMap via the Overpass API. Cached lazily into Redis as 0.5° geographic tiles on first request, with a 7-day TTL.
- **Deploy:** Helm chart + Kubernetes (`ingress-nginx` + cert-manager), released via goreleaser.

No accounts. No tracking. The browser asks for geolocation; the backend never stores per-user data.

## Docs

Engineering docs live under [`docs/`](docs/):

- [architecture.md](docs/architecture.md) — system overview, request flow, design decisions.
- [development.md](docs/development.md) — clone, build, test, replay.
- [deployment.md](docs/deployment.md) — release pipeline, GitOps notes, dev deploys.

Workflow rules for AI coding agents are in [AGENTS.md](AGENTS.md).

## Status

Pre-MVP.