Skip to content

NikBLN/weilSieDichLieben

Repository files navigation

weilSieDichLieben Banner

weilSieDichLieben

Configure your own personal BVG Public Transport Anzeigetafel and enjoy public transport again!


Table of Contents

About

weilSieDichLieben is a small React application that displays live departure information from the Berlin public transport system (BVG). It was built so you can run your very own BVG style departure board on a spare tablet, monitor or phone. Configure the stops you care about and the page remembers your settings so the board is ready whenever you open it.

The application fetches its data from the public BVG API and is optimized to run in a fullscreen web view. It works best on tablets but can be used on any device with a modern browser.

Demo

Visit www.weilSieDichLieben.de to try the app without installing anything. On iOS/iPadOS you can add the page to your home screen via the "Share" button to run it in fullscreen mode.

Features

  • Configure multiple stations and transport types (bus, subway, tram, ferry, etc.)
  • Choose the number of results and a minimum departure time
  • Adjustable font size and optional scrolling remarks below departures
  • Option to automatically hide the header/footer after a short period of inactivity
  • Share your configuration via a generated URL
  • Support for German and English

Getting Started

You can either use the hosted version above or run the project locally.

Prerequisites

  • Node.js (tested with Node 20)
  • npm comes bundled with Node.js

Installation

# clone the repository
git clone https://github.com/NikBLN/weilSieDichLieben.git
cd weilSieDichLieben

# install dependencies
npm install

Running Locally

npm start

This will start the development server at http://localhost:3000 and open the app in your browser.

Building

For a production build run:

npm run build

The output will be placed in the build/ directory. The repository contains a GitHub Actions workflow that deploys this folder via FTP whenever changes are pushed to the main branch.

Testing

This project uses Jest together with React Testing Library. To run the test suite execute:

npm test -- --watchAll=false

Development

The React source code lives in the src directory while static assets such as index.html reside in public. Feel free to open issues or pull requests if you want to contribute. Please read our Code of Conduct before participating.

Cookie Usage

This project stores a few cookies in your browser to save your personal settings. They are only used to improve your experience and are never shared with third parties. The cookies currently in use are:

  • bvgDepatureSelectedStations – list of configured stations
  • fontSize – custom font size for the departure board
  • remarksVisibility and standardRemarksVisibility – whether to display scrolling remarks
  • autoHide – remember if header/footer should auto‑hide
  • language – chosen interface language
  • notificationVersion – prevents showing the same update notification twice
  • hideDepartureCol - remember if the departure column should be hidden

All cookies expire after about one year and are not used for tracking or advertising purposes.

Contributing

Contributions are welcome! Please open an issue to discuss your ideas or submit a pull request. By contributing you agree to abide by the Code of Conduct.

License

This project is licensed under the MIT License. See the license file for details.

About

Your unofficial but personalized BVG departure board

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors