Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 2.69 KB

index.md

File metadata and controls

57 lines (39 loc) · 2.69 KB
title layout
OneBusAway Developer Documentation
page

This is the official documentation for all the application modules the make up the OneBusAway web application and API framework.

Current Version: <%= site.metadata.oba_version %> (Released <%= site.metadata.oba_version_release_date %>)

You can find download links to the prebuilt binaries on our Downloads page.

Details on all releases can be found in the Release Notes.

Help us improve our documentation!

This is a living website that needs help from the entire OneBusAway community:

  • Notice a typo?
  • See some outdated or incorrect information?
  • Want to improve our web design?

Help out! If you can edit a text file, you can improve this site. Find the source code on GitHub.

Functionality

The OneBusAway application suite's primary function is to share real-time public transit information with riders across a variety of interfaces:

  • OneBusAway Web - A variety of web interfaces to transit data
    • A standard web interface to transit data, including maps and stop pages with real-time info
    • A mobile-optimized version of the web interface for mobile browsers
    • A text-only version of the web interface for more-basic mobile browsers
  • OneBusAway REST API - A RESTful web-service that can be used to quickly write applications built on top of transit data. This API powers:
  • OneBusAway Phone - A Interactive Voice Response (IVR) phone application for accessing real-time transit information
  • OneBusAway SMS - An SMS service for accessing real-time transit information
  • OneBusAway Sign Mode - A interface mode optimized for large public displays

These interfaces are powered by a transit-data back-end module that combines raw transit data (GTFS, GTFS-realtime, etc) into an optimized data-bundle appropriate for application development.

Quick-Start

Want to quickly get started with OneBusAway? Check out the Quickstart Guide.

Guides

There are a number of guides to help get you started with installing, configuring, and running OneBusAway:

If those guides don't help, there are other resources for getting help.