Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 4.5 KB

README.md

File metadata and controls

61 lines (36 loc) · 4.5 KB
Raw

OneBusAway for Android Android CI Build

This is the official Android / Fire Phone app for OneBusAway, a project of the non-profit Open Transit Software Foundation!

Get it on Google Play

OneBusAway for Android provides:

  1. Real-time arrival/departure information for public transit
  2. A browse-able map of nearby stops
  3. A list of favorite bus stops
  4. Reminders to notify you when your bus is arriving or departing
  5. The ability to search for nearby stops or routes
  6. Real-time multimodal trip planning, using real-time transit and bike share information (requires a regional OpenTripPlanner server)
  7. Bike share map layer, which includes real-time availability information for floating bikes and bike rack capacity (requires a regional OpenTripPlanner server)
  8. Issue reporting to any Open311-compliant issue management system (see this page for details)

OneBusAway for Android automatically keeps track of your most used stops and routes, and allows you to put shortcuts on your phone's home screen for any stop or route you choose.

Alpha and Beta Testing

Get early access to new OneBusAway Android versions, and help us squash bugs! See our Testing Guide for details.

Build Setup

Want to build the project yourself and test some changes? See our build documentation.

Contributing

We welcome contributions to the project! Please see our Contributing Guide for details, including Code Style Guidelines and Template.

System Architecture

Curious what servers power certain features in OneBusAway Android? Check out the System Architecture page.

Deploying OneBusAway Android in Your City

There are two ways to deploy OneBusAway Android in your city:

  1. Join the OneBusAway multi-region project - The easiest way to get started - simply set up your own OneBusAway server with your own transit data, and get added to the OneBusAway apps! See this page for details.
  2. Deploy a rebranded version of OneBusAway Android as your own app on Google Play - Requires a bit more maintenance, but it allows you to set up your own app on Google Play based on the OneBusAway Android source code. See rebranding page for details.

Testing Your Own OneBusAway/OpenTripPlanner servers

Did you just set up your own OneBusAway and/or OpenTripPlanner server? You can test both in this app without compiling any Android code. Just download the app from Google Play, and see our Custom Server Setup Guide for details.

Permissions

In order to support certain features in OneBusAway, we need to request various permissions to access information on your device. See an explanation of why each permission is needed here.

Troubleshooting

Things not going well building the project? See our Troubleshooting section. If you're a user of the app, check out our FAQ.

OneBusAway Project

Want to learn more about the OneBusAway project, a project of the non-profit Open Transit Software Foundation? Read up on the entire Application Suite and/or learn more about the mobile apps.