README.md

Transit Alarm for MTA

Transit Alarm for MTA is a location-based notification app for New York and Connecticut public transportation that will notify you when you're approaching your destination. Whether you're traveling on the Long Island Rail Road (LIRR), Metro-North Railroad (MNR), or the NYC Subway system (NYCT), you'll get alerted when you're close to a selected station.

Transit Alarm for MTA was built as a part of the MTA 2024 Open Data Challenge, using MTA open datasets for station names, geolocations, and colors.

The app is a web app that is cross-compiled into native iOS and Android apps using Capacitor. The latest iOS release can be found on the Apple App Store, and the latest Android release (APK) can be found in the GitHub releases page.

Installation

$ cp .env.example ~/.env/transit-alarm
$ source ~/.env/transit-alarm
$ npm install .

Pull data from MTA Open Data

$ npm run sync:mta

Build and preview

$ npm run build
$ npm run preview:web      # Runs a local web server
$ npm run preview:ios      # Opens an iOS simulator
$ npm run preview:android  # Opens an Android simulator

Open the iOS or Android project

$ npm run ide:ios          # Opens Xcode
$ npm run ide:android      # Opens Android Studio

Deploy the web app

$ npm run deploy:web