Skip to content

RouteReality V1.0

Choose a tag to compare

@dillonhuston dillonhuston released this 24 Jan 17:41
· 47 commits to main since this release

v0.1.0 "Bootstrap" - January 2026

Initial Release

First public release of RouteReality , a crowdsourced journey tracking and prediction system for public transit.

Features

Journey Tracking

  • Start and track active bus journeys
  • Submit real-time journey events (arrived, delayed, stop reached)
  • Complete journey lifecycle management with state validation

Smart Predictions

  • Tiered prediction engine that improves with data volume
  • 20+ user journeys: Uses only real user data
  • 5-19 journeys: Blends user data with official timetables
  • <5 journeys: Falls back to official schedules
  • Statistical analysis using median (robust to outliers) with 5+ data points

API Endpoints

  • GET /route/routes - List all available routes
  • GET /route/routes/{route_id}/stops - Get stops for a route
  • POST /journeys/start - Create new journey with predictions
  • POST /journeys/{journey_id}/event - Update journey status

Data Model

  • Support for multiple routes and stops
  • Journey state machine (STARTED → DELAYED → ARRIVED → STOP_REACHED)
  • Track both user-submitted and official timetable data
  • Store predictions for accuracy tracking

Technical Details

  • Built with FastAPI and SQLAlchemy
  • PostgreSQL database with proper indexing
  • RESTful API with OpenAPI documentation
  • UTC timezone handling throughout
  • Comprehensive logging for debugging and monitoring

Known Limitations

  • No authentication or authorization
  • No time-of-day or day-of-week patterns in predictions
  • No real-time journey updates (polling only)
  • Limited to completed journey predictions
  • No data cleanup for old journeys

Requirements

  • Python 3.9+
  • PostgreSQL
  • See requirements.txt for full dependency list

Documentation

  • Quick start guide in README.md
  • Full technical documentation in TECHNICAL_DOCUMENTATION.md
  • API documentation at /docs endpoint

What's Next (v0.2.0)

  • User authentication and personal journey history
  • Time-based prediction patterns (rush hour awareness)
  • WebSocket support for real-time updates
  • Data quality improvements and outlier filtering
  • Expanded test coverage

Contributors Welcome! Check out CONTRIBUTING.md for areas where we need help.

Feedback? Open an issue or submit a PR. We're especially interested in:

  • Prediction algorithm improvements
  • Real-world usage feedback
  • Transit agency integrations
  • Performance optimizations

Full Changelog: https://github.com/dillionhuston/bus-tracker-api/commits/RouteRealityv0.10Beta