Skip to content
kiel-livePublic

Repository files navigation

kiel-live

This app allows you to view Kiels public transport (busses, bus-stops) in realtime.

build release

Features

  • View realtime bus positions and bus-stops on map
  • Get realtime information (route, direction, eta) of bus departures of a specific bus-stop
  • Add bus-stops to favorites
  • View trip stops of a bus

Screenshots

Screenshots of Kiel-Live Screenshots of Kiel-Live in dark mode

Development

Structure

The project contains following parts:

  • app/: A PWA written with Vue3
  • android-app/: A native android app wrapper of the PWA
  • collectors/*: Multiple agents to scrape data from different apis
  • nats/: The NATS server used as message broker to stream data from collectors to the PWA clients

PWA development

Copy the .env.sample file to .env. For the PWA development you only need to set VITE_NATS_URL. You can set it to wss://api.kiel-live.ju60.de/ to use the production server so you don't need to start your own backend (nats & collectors).

cd app/
pnpm install # install dependencies
pnpm run dev # start the PWA

Nats & collectors development

Nats is the message broker used to bring data from the collectors to the PWA clients.

To start Nats simply copy the .env.sample file to .env, adjust as needed and run docker-compose up -d.

Releases

Packages

Used by

Contributors

Languages