diff --git a/CREDITS.md b/CREDITS.md new file mode 100644 index 0000000..99ba1bb --- /dev/null +++ b/CREDITS.md @@ -0,0 +1,48 @@ +# Credits & Attributions + +Dieses Projekt nutzt folgende externe Ressourcen und Dienste: + +## 🎨 DotMatrix Font + +- **Quelle**: [weilSieDichLieben Repository](https://github.com/NikBLN/weilSieDichLieben) +- **Autor**: [@NikBLN](https://github.com/NikBLN) +- **Verwendung**: Authentisches VBB-Design für die App +- **Datei**: `DotMatrix.ttf` + +## 🚇 VBB Transport REST API + +- **Quelle**: [v6.vbb.transport.rest](https://v6.vbb.transport.rest) +- **Dokumentation**: [GitHub - derhuerst/vbb-rest](https://github.com/derhuerst/vbb-rest) +- **Autor**: [@derhuerst](https://github.com/derhuerst) +- **Verwendung**: Echtzeit-Verkehrsdaten für Berlin-Brandenburg +- **Lizenz**: ISC License + +## 🏛️ VBB (Verkehrsverbund Berlin-Brandenburg) + +- **Hinweis**: Dies ist ein **inoffizielles Projekt** +- Die App steht in **keiner Verbindung** zum VBB +- VBB-Farben (#FFED00) und Designelemente werden unter Fair Use verwendet +- Keine offizielle Unterstützung oder Billigung durch den VBB + +## 📝 Weitere Hinweise + +### Markenzeichen +- "VBB", "S-Bahn", "U-Bahn" sind eingetragene Marken ihrer jeweiligen Eigentümer +- Diese App verwendet diese Begriffe ausschließlich zu Identifikationszwecken + +### Haftungsausschluss +- Die Echtzeit-Daten werden von der VBB API bereitgestellt +- Keine Garantie für Richtigkeit, Vollständigkeit oder Aktualität +- Offizielle Fahrplanauskünfte unter [vbb.de](https://www.vbb.de) + +## 🙏 Danke + +Ein großes Dankeschön an: +- [@NikBLN](https://github.com/NikBLN) für die tolle DotMatrix Font +- [@derhuerst](https://github.com/derhuerst) für die hervorragende VBB API +- Die Open-Source Community für Inspiration und Tools +- Alle Contributors die dieses Projekt verbessern + +--- + +Bei Fragen zu Lizenzen oder Attributionen bitte ein Issue öffnen. diff --git a/README.md b/README.md index a16298a..e179e2a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,98 @@ -# VBB-Status-Web-App -Die WebApp zeigt dir den aktuellen Status der ausgewählten Haltestelle im öffentlichen Verkehr. Du bekommst Echtzeit-Informationen zu Ankunftszeiten, Verspätungen und anderen wichtigen Details, damit du immer weißt, wann dein Bus oder Zug kommt. +# VBB Netz Status +*by Aaron K.* + +Progressive Web App für Echtzeit-Abfahrten im VBB (Berlin-Brandenburg). + +## Features + +- 📍 **GPS-Standortsuche** - Findet automatisch die nächste Station +- 🔍 **Stationssuche** - Autocomplete für alle VBB-Stationen +- ⏱️ **Echtzeit-Updates** - Smart Refresh alle 30s (nur Werte, kein Flackern) +- 📱 **PWA** - Installierbar als native App (iOS/Android/Desktop) +- 🔄 **Pull-to-Refresh** - Intuitive Aktualisierung +- 📊 **Detaillierte Infos** - Alle Halte, Verspätungen, Störungen +- 🎨 **VBB Design** - Authentische Farben & DotMatrix Font +- ⚡ **Performance** - Minimalistisch, keine Animationen +- 📵 **Offline** - Service Worker Support +- 🔒 **Rate-Limiting** - Max 100 API-Anfragen/Min + +## Installation + +```bash +# Repository klonen +git clone https://github.com/yourusername/vbb-netz-status.git + +# Mit lokalem Server starten +python3 -m http.server 8000 +# oder: npx serve + +# Browser öffnen +open http://localhost:8000 +``` + +**Benötigt:** +- HTTPS (für GPS & Service Worker) +- `DotMatrix.ttf` im Root ([Download](https://github.com/NikBLN/weilSieDichLieben)) +- `images/favicon.png` + +## Als App installieren + +- **iOS**: Safari → Teilen → "Zum Home-Bildschirm" +- **Android**: Chrome → Menü → "App installieren" +- **Desktop**: Adressleiste → Install-Symbol + +## Tech Stack + +- Vanilla JavaScript (kein Framework) +- [VBB Transport REST API v6](https://v6.vbb.transport.rest) +- Service Worker (Offline) +- PWA (Web Manifest) +- [DotMatrix Font](https://github.com/NikBLN/weilSieDichLieben) by NikBLN + +## Logo erstellen + +```bash +# Vorschau aller Konzepte +open logo-preview.html +``` + +3 SVG-Referenzen verfügbar: +- `logo-reference-network.svg` (empfohlen) +- `logo-reference-su.svg` +- `logo-reference-metro.svg` + +Siehe `LOGO_PROMPT.md` für Details. + +## Browser-Support + +- ✅ iOS Safari 11.3+ +- ✅ Android Chrome 72+ +- ✅ Desktop (Chrome, Firefox, Safari, Edge) + +## Troubleshooting + +**GPS funktioniert nicht?** +- HTTPS erforderlich +- Standortdienste aktivieren +- Browser-Berechtigung erteilen + +**API-Fehler?** +- Rate-Limit (100/Min) erreicht +- Keine Internetverbindung + +## Lizenz + +MIT License - siehe [LICENSE](LICENSE) + +## Credits & Danksagung + +- **[VBB Transport REST API](https://v6.vbb.transport.rest)** - Echtzeit-Verkehrsdaten +- **[DotMatrix Font](https://github.com/NikBLN/weilSieDichLieben)** by [@NikBLN](https://github.com/NikBLN) - Authentisches VBB-Feeling + +## Autor + +Aaron K. + +--- + +*Inoffizielles Projekt - Keine Verbindung zum VBB* diff --git a/gitignore b/gitignore new file mode 100644 index 0000000..6d8d32e --- /dev/null +++ b/gitignore @@ -0,0 +1,26 @@ +# Font (muss separat heruntergeladen werden) +# Quelle: https://github.com/NikBLN/weilSieDichLieben +DotMatrix.ttf + +# Icons (eigene erstellen oder herunterladen) +images/favicon.png +images/icon-*.png + +# System Files +.DS_Store +Thumbs.db + +# IDE +.vscode/ +.idea/ +*.swp +*.swo +*~ + +# Logs +*.log +npm-debug.log* + +# Temporary +*.tmp +*.bak