Web frontend for the Naviqore public transit routing engine.
- Stop & Schedule Explorer: Browse stops, view departures and route details on an interactive map.
- Connection Routing: Query point-to-point transit connections with detailed leg-by-leg results.
- Isoline Map: Visualise reachability areas by travel time or number of transfers from a given stop.
- System Monitor & Benchmark: Monitor backend health and benchmark routing performance.
- Mock Data Mode: Explore the app without a backend using built-in Swiss transit sample data.
-
Clone the repository:
git clone https://github.com/naviqore/public-transit-viewer.git cd public-transit-viewer -
Install dependencies and start the dev server:
npm install npm run dev
-
Run the full quality gate:
npm run ci
This repository follows a story-first workflow for all intentional changes.
- Create a story (feature, bugfix, test, etc.):
#file:new-story.prompt.md <what you want to change>
-
Review and approve the generated story in
docs/stories/. -
Let the agent implement the story:
#file:implement-existing-story.prompt.md <story-id>
- Review the implementation and confirm; the agent commits and closes the story.
Environment variables (prefix VITE_ as required by Vite):
| Variable | Default | Description |
|---|---|---|
VITE_API_BASE_URL |
http://localhost:8080 |
Naviqore backend URL. When set, mock-data toggle is hidden. |
VITE_ENABLE_MOCK_DATA |
false |
Start in mock-data mode automatically. |
VITE_DISABLE_BENCHMARK |
false |
Hide the Benchmark tab (recommended for public deployments). |
docker run -p 80:80 \
-e VITE_API_BASE_URL=https://api.your-naviqore-instance.com \
-e VITE_DISABLE_BENCHMARK=true \
ghcr.io/naviqore/public-transit-viewer:latestA live demo with mock data is deployed automatically on every release to GitHub Pages.
Deployment workflow behavior:
- Release-driven deploy: runs when a release is published.
- Manual deploy (
workflow_dispatch): intentionally kept for first-time bootstrap, retries, and backfills.
Repository prerequisite:
- GitHub Pages must be enabled in repository settings with Source set to GitHub Actions before deployments can succeed.
- If Pages is not enabled, the deploy workflow fails early with a direct remediation message.
Release Please changelog note:
CHANGELOG.mdis generated by Release Please and excluded from Prettier checks to keep the quality gate strict and deterministic for repository-maintained source/config files.
Contributions are welcome! Please open an issue or pull request on GitHub.
This project is licensed under the MIT license. See the LICENSE file for details.