/findmybusnj-swift

Contains the swift rewrite of Find My Bus NJ iOS App

Primary LanguageSwiftGNU General Public License v3.0GPL-3.0

FIND MY BUS NJ 2 Build Status

An app for tracking NJ Transit bus times.

Find My Bus NJ 2

Dependancies

Getting started

  1. Install fastlane and imagemagick
  2. Install cocoapods and run pod install (unnecessary really since Pods/ folder is checked into repo)
  3. Open .xcworkspace file in Xcode and get developing

Version: 2.0 Roadmap

TODO:

  • User should be able to look up stop given a bus if they don't know it
  • User should be able to look up gates and bus time tables
  • Expand test coverage

Completed:

  • Migrate old version to a totally rewritten app in Swift
  • Use cards that show bus and expected arrival - ✓
    • tapping on them should callout to the Maps and show the transit mode that shows the user the way the bus will take, and how long it may take to get there.
  • Use Google's map API to return all bus stops and overlay them ontop of mapkit based on User's location
  • User should be able to get navigation to a stop via the maps application
  • Look into releasing/using unowned on self when in a closure
  • Add 3D Touch Shortcuts
  • Add Today View Widget

Future Updates:

  • Add watch app (native)

Documentation

To generate documentation, simply use Jazzy

sudo gem install jazzy

Then run jazzy in the base folder. Documentation will be put out to the docs folder.

Contributing

  1. Fork the repo
  2. Checkout a new branch using any of the following prefixes"
  • feature/name-of-feature
  • fix/name-of-bug

Credits

  • Thanks to Icons8 for providing free icons.