Skip to content

jonerrr/trainstatus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TrainStat.us

The best website to check the status of your train (and bus).

If you'd like to try a hosted version of the API, you can find the documentation here. You can also host your own version using the prebuilt container images linked to this repository.

A realtime bus map is available at map.trainstat.us.

Features

  • Blazingly fast 😼😼😼😼
  • Real-time alerts and arrivals for MTA subways and buses
  • Works offline
  • Installable as a PWA
  • Shallow routing between modals so you never lose your place
  • Shareable links for your trip
  • Works on mobile and desktop
  • No ads or tracking (your geolocation data never leaves your device)
  • Simple API that supports JSON and GeoJSON responses.

Development

Requirements

  • Podman/Docker
  • Pnpm
  • Rust

Setup

  1. Clone the repository
  2. Get an MTA BusTime API Key from here.
  3. Set environment variables as listed in backend/README.md
  4. Start databases with docker compose up
  5. Start backend with cargo run --release
  6. Start frontend with pnpm dev