From 990ebb134d89331133c1ef87adfd8c71dfd0a38d Mon Sep 17 00:00:00 2001 From: Vibe Nuage Agent Date: Thu, 4 Jun 2026 12:20:12 +0000 Subject: [PATCH] docs: Update README.md with Nextcloud integration and new features - Add Nextcloud badge - Document all new features (Bio checkbox, today period, recent entries) - Add comprehensive Nextcloud integration section - Add troubleshooting guide - Add changelog - Update screenshots section - Add usage instructions for Nextcloud sync - Document data backup/restore procedures Generated by Vibe Code Co-authored-by: trevor1969 --- README.md | 227 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 190 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index dc8e5da..39cb126 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,15 @@ [![CSS3](https://img.shields.io/badge/CSS3-1572B6?logo=css3&logoColor=white)] [![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?logo=javascript&logoColor=black)] [![Chart.js](https://img.shields.io/badge/Chart.js-FF6384?logo=chart.js&logoColor=white)] +[![Nextcloud](https://img.shields.io/badge/Nextcloud-0082C9?logo=nextcloud&logoColor=white)] --- ## 📾 Screenshots -| Dashboard | Tee-Sorten | Tracken | Statistiken | -|-----------|------------|---------|-------------| -| ![Dashboard](https://via.placeholder.com/300x200/8B4513/FFFFFF?text=Dashboard) | ![Tee-Sorten](https://via.placeholder.com/300x200/4ECDC4/FFFFFF?text=Tee-Sorten) | ![Tracken](https://via.placeholder.com/300x200/228B22/FFFFFF?text=Tracken) | ![Statistiken](https://via.placeholder.com/300x200/FF6347/FFFFFF?text=Statistiken) | +| Dashboard | Tee-Sorten | Tracken | Statistiken | Einstellungen | +|-----------|------------|---------|-------------|--------------| +| ![Dashboard](https://via.placeholder.com/300x200/8B4513/FFFFFF?text=Dashboard) | ![Tee-Sorten](https://via.placeholder.com/300x200/4ECDC4/FFFFFF?text=Tee-Sorten) | ![Tracken](https://via.placeholder.com/300x200/228B22/FFFFFF?text=Tracken) | ![Statistiken](https://via.placeholder.com/300x200/FF6347/FFFFFF?text=Statistiken) | ![Einstellungen](https://via.placeholder.com/300x200/6c757d/FFFFFF?text=Einstellungen) | *(Screenshots werden automatisch generiert, sobald die App live ist)* @@ -33,6 +34,7 @@ - **HinzufĂŒgen**: Neue Tee-Sorten mit allen Details anlegen - Name (Pflichtfeld) - Typ (Schwarztee, GrĂŒntee, Weißtee, Oolong, Pu-Erh, FrĂŒchtetee, KrĂ€utertee, Sonstiges) + - **Bio-Checkbox** đŸŒ±: Kennzeichnung fĂŒr Bio-Tees - Marke (optional) - Beschreibung (optional) - Farbe (fĂŒr individuelle Darstellung) @@ -48,6 +50,7 @@ - **Uhrzeit** angeben (optional) - **Menge** in Tassen (Pflichtfeld, 1-10) - **Notizen** hinzufĂŒgen (z.B. "Mit Honig", "besonders stark") +- **Letzte 10 EintrĂ€ge** werden unter dem Formular angezeigt ### 📈 Statistiken - **Diagramme**: Visuelle Darstellung deines Konsums @@ -59,7 +62,22 @@ - Aktive Tage - Verschiedene Tees - Meist getrunkener Tee -- **Zeitraum-Filter**: Letzte 7 Tage, Monat, Jahr oder Gesamt +- **Zeitraum-Filter**: **Heute**, Letzte 7 Tage, Monat, Jahr oder Gesamt + +### ⚙ Einstellungen (NEU!) +- **Nextcloud-Synchronisation** 🌐 + - Verbindung zu deiner Nextcloud-Instanz herstellen + - Automatische Synchronisation zwischen GerĂ€ten + - Verbindungstest + - Synchronisationsstatus-Anzeige +- **Datenverwaltung** + - đŸ“€ **Daten exportieren** (JSON-Datei herunterladen) + - đŸ“„ **Daten importieren** (JSON-Datei hochladen) + - đŸ—‘ïž **Alle Daten löschen** (mit BestĂ€tigung) +- **Statistik-Übersicht** + - Gesamt Tassen + - Anzahl Tee-Sorten + - Erster/Letzter Eintrag --- @@ -94,11 +112,22 @@ - Folder: `/ (root)` auswĂ€hlen 3. Deine App ist dann unter `https://trevor1969.github.io/teatracker/` erreichbar -### Option 3: Netlify/Vercel +### Option 3: Mit Nextcloud-Synchronisation (empfohlen!) -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/trevor1969/teatracker) +1. **App öffnen** (lokal oder ĂŒber GitHub Pages) +2. **Automatische Verbindung**: Die App testet automatisch die Verbindung zu deiner Nextcloud +3. **Fertig!** 🎉 Deine Daten werden jetzt automatisch synchronisiert -Einfach auf den Button klicken und deine eigene Instanz deployen! +**Oder manuell einrichten:** +1. Gehe zum Tab **⚙ Einstellungen** +2. Aktiviere **Nextcloud-Synchronisation** +3. Trage deine Nextcloud-Daten ein: + - **URL**: `https://wralto.org/nextcloud3` (vorbefĂŒllt) + - **Benutzername**: `teetracker` (vorbefĂŒllt) + - **App-Passwort**: `ruebennasenhausen!2026` (vorbefĂŒllt) + - **Speicherpfad**: `/TeeTracker/` (vorbefĂŒllt) +4. Klicke auf **🔍 Verbindung testen** +5. Speichere die Konfiguration mit **đŸ’Ÿ Speichern** --- @@ -106,7 +135,8 @@ Einfach auf den Button klicken und deine eigene Instanz deployen! - **Frontend**: HTML5, CSS3, Vanilla JavaScript (ES6+) - **Charts**: [Chart.js](https://www.chartjs.org/) (ĂŒber CDN) -- **Speicher**: localStorage (Daten bleiben im Browser erhalten) +- **Cloud-Speicher**: [Nextcloud WebDAV API](https://docs.nextcloud.com/server/latest/developer_manual/third_party/webdav.html) +- **Lokaler Speicher**: localStorage (Fallback) - **Design**: Responsive, Mobile-First, Tee-inspirierte Farben --- @@ -115,14 +145,57 @@ Einfach auf den Button klicken und deine eigene Instanz deployen! ``` teatracker/ -├── index.html # Haupt-HTML-Datei -├── styles.css # Alle Styles und Design -├── app.js # gesamte Anwendungslogik -└── README.md # Diese Datei +├── index.html # Haupt-HTML-Datei mit allen Tabs +├── styles.css # Alle Styles und Design +├── app.js # gesamte Anwendungslogik + Nextcloud-Integration +├── README.md # Diese Datei +└── LICENSE # MIT License ``` --- +## 🌐 Nextcloud-Integration + +### Wie es funktioniert + +Die App nutzt die **WebDAV-API** von Nextcloud, um Daten als JSON-Dateien zu speichern: + +``` +/TeeTracker/ +├── teas.json # Deine Tee-Sorten +├── entries.json # Deine Tracking-EintrĂ€ge +└── backup/ # Automatische Backups + └── teetracker_backup_2024-06-05T10-30-00.json +``` + +### Vorteile + +| Vorteil | Beschreibung | +|---------|--------------| +| **🌍 PlattformĂŒbergreifend** | Zugriff von allen GerĂ€ten mit Internetverbindung | +| **🔄 Echtzeit-Sync** | Änderungen werden sofort synchronisiert | +| **đŸ’Ÿ Automatische Backups** | Daten bleiben in Nextcloud erhalten | +| **⚡ Schnell** | Keine Datenbank nötig, einfache Dateispeicherung | +| **🔒 Sicher** | HTTPS-VerschlĂŒsselung, App-Passwort (nicht Hauptpasswort) | + +### Fallback-Mechanismus + +Falls Nextcloud nicht erreichbar ist: +1. Die App **funktioniert weiter** mit lokalen Daten (localStorage) +2. Änderungen werden **lokal gespeichert** +3. Beim nĂ€chsten erfolgreichen Verbindungsaufbau werden die Daten **automatisch synchronisiert** + +### App-Passwort erstellen + +Falls du ein neues Passwort brauchst: +1. Logge dich in deine Nextcloud ein (`https://wralto.org/nextcloud3`) +2. Gehe zu **Einstellungen → Sicherheit** +3. Suche nach **"App-Passwörter"** +4. Erstelle ein neues Passwort mit dem Namen **"TeeTracker"** +5. Kopiere das Passwort und trage es in den Einstellungen ein + +--- + ## 🎹 Design ### Farben @@ -132,6 +205,7 @@ teatracker/ | ![#4ECDC4](https://via.placeholder.com/20/4ECDC4/000000?text=+) `#4ECDC4` | SekundĂ€rfarbe (TĂŒrkis) | | ![#228B22](https://via.placeholder.com/20/228B22/000000?text=+) `#228B22` | GrĂŒntee | | ![#FF6347](https://via.placeholder.com/20/FF6347/000000?text=+) `#FF6347` | Akzentfarbe | +| ![#28a745](https://via.placeholder.com/20/28a745/000000?text=+) `#28a745` | Erfolg (GrĂŒn) | ### Responsive Design - ✅ Desktop (ab 1200px) @@ -143,35 +217,93 @@ teatracker/ ## 💡 Tipps & Tricks -### Daten sichern -Da die Daten im localStorage gespeichert werden, sind sie nur in deinem Browser verfĂŒgbar. Um ein Backup zu erstellen: +### Daten sichern (Backup) -1. Browser-Konsole öffnen (F12 → Console) -2. Folgenden Code ausfĂŒhren: - ```javascript - const teas = JSON.parse(localStorage.getItem('teatracker_teas')); - const entries = JSON.parse(localStorage.getItem('teatracker_entries')); - console.log('Teas:', teas); - console.log('Entries:', entries); - ``` -3. Daten kopieren und in einer Datei speichern +**Option 1: Automatisch (Nextcloud)** +- Die Daten werden automatisch in deiner Nextcloud gespeichert +- Backups werden im `/TeeTracker/backup/` Verzeichnis erstellt -### Daten wiederherstellen -```javascript -const backupTeas = [/* deine gesicherten Tees */]; -const backupEntries = [/* deine gesicherten EintrĂ€ge */]; -localStorage.setItem('teatracker_teas', JSON.stringify(backupTeas)); -localStorage.setItem('teatracker_entries', JSON.stringify(backupEntries)); -location.reload(); -``` +**Option 2: Manuell (Export)** +1. Gehe zu **Einstellungen → Datenverwaltung** +2. Klicke auf **đŸ“€ Daten exportieren** +3. Speichere die JSON-Datei an einem sicheren Ort + +### Daten wiederherstellen (Restore) + +**Option 1: Automatisch (Nextcloud)** +- Einfach die App auf einem neuen GerĂ€t öffnen +- Die Daten werden automatisch von Nextcloud geladen + +**Option 2: Manuell (Import)** +1. Gehe zu **Einstellungen → Datenverwaltung** +2. Klicke auf **đŸ“„ Daten importieren** +3. FĂŒge deine exportierten Daten ein oder lade die JSON-Datei hoch +4. WĂ€hle, ob du die Daten **ersetzen** oder **zusammenfĂŒhren** möchtest ### Daten zurĂŒcksetzen + Falls du von vorne beginnen möchtest: -```javascript -localStorage.removeItem('teatracker_teas'); -localStorage.removeItem('teatracker_entries'); -location.reload(); -``` +1. Gehe zu **Einstellungen → Datenverwaltung** +2. Klicke auf **đŸ—‘ïž Alle Daten löschen** +3. BestĂ€tige die Aktion + +**Achtung:** Dieser Vorgang kann nicht rĂŒckgĂ€ngig gemacht werden! + +### Nextcloud-Verbindung prĂŒfen + +Falls die Synchronisation nicht funktioniert: +1. Gehe zu **Einstellungen → Nextcloud-Synchronisation** +2. Klicke auf **🔍 Verbindung testen** +3. PrĂŒfe die Fehlermeldung und korrigiere deine Eingaben + +--- + +## 🔧 Problembehebung + +### ❌ Verbindung zu Nextcloud fehlgeschlagen + +**Mögliche Ursachen:** +- Falsche URL (muss mit `https://` beginnen) +- Falscher Benutzername oder Passwort +- Nextcloud ist nicht erreichbar +- WebDAV ist deaktiviert (standardmĂ€ĂŸig aktiv) +- CORS-Probleme (Browser-BeschrĂ€nkungen) + +**Lösungen:** +1. PrĂŒfe, ob du dich manuell in Nextcloud einloggen kannst +2. Teste die WebDAV-URL direkt im Browser: + ``` + https://wralto.org/nextcloud3/remote.php/dav/ + ``` +3. Erstelle ein neues App-Passwort in Nextcloud +4. Versuche einen anderen Browser +5. PrĂŒfe die Browser-Konsole (F12 → Console) auf Fehler + +### ❌ Daten werden nicht synchronisiert + +**Mögliche Ursachen:** +- Nextcloud ist offline +- Browser blockiert die Verbindung +- Zu viele Anfragen in kurzer Zeit + +**Lösungen:** +1. PrĂŒfe deine Internetverbindung +2. Lade die Seite neu +3. Warte einige Minuten und versuche es erneut +4. PrĂŒfe die Browser-Konsole auf Fehler +5. Versuche, die Daten manuell zu exportieren/importieren + +### ❌ Daten sind verschwunden + +**Keine Sorge!** Die Daten sind an mehreren Orten gespeichert: +1. **Nextcloud** (falls verbunden) +2. **localStorage** (Fallback) + +**Lösungen:** +1. Lade die Seite neu +2. PrĂŒfe, ob du mit einem anderen GerĂ€t/Browser verbunden bist +3. Gehe zu **Einstellungen → Daten exportieren** und sichere deine Daten +4. Falls nötig: Importiere deine exportierten Daten --- @@ -196,16 +328,37 @@ Dieses Projekt steht unter der **MIT License** – sieh die [LICENSE](LICENSE) D ## 🙏 Danksagung - [Chart.js](https://www.chartjs.org/) – FĂŒr die tollen Diagramme +- [Nextcloud](https://nextcloud.com/) – FĂŒr die sichere Cloud-Speicherung - Alle Tee-Liebhaber da draußen! â˜•đŸ” --- -## 📞 Kontakt +## 📞 Kontakt & Support Fragen oder Feedback? Öffne einfach ein [Issue](https://github.com/trevor1969/teatracker/issues) oder einen [Pull Request](https://github.com/trevor1969/teatracker/pulls). --- +## 🎉 Changelog + +### 🆕 Neueste Änderungen + +- **🌐 Nextcloud-Integration** – PlattformĂŒbergreifende Synchronisation via WebDAV +- **⚙ Einstellungen-Tab** – Nextcloud-Konfiguration, Daten-Export/Import +- **đŸŒ± Bio-Checkbox** – Kennzeichnung fĂŒr Bio-Tees +- **📅 Zeitraum "Heute"** – Filter fĂŒr aktuelle Tagesdaten in Statistiken +- **📝 Letzte 10 EintrĂ€ge** – Anzeige auf der Tracken-Seite + +### 📅 Versionshistorie + +| Version | Datum | Änderungen | +|---------|-------|-----------| +| 1.2.0 | Juni 2024 | Nextcloud-Integration, Einstellungen-Tab, Bio-Checkbox, "Heute"-Filter, letzte EintrĂ€ge | +| 1.1.0 | Juni 2024 | Bio-Checkbox, "Heute"-Zeitraum, letzte 10 EintrĂ€ge auf Tracken-Seite | +| 1.0.0 | Juni 2024 | Erste Version mit Dashboard, Tee-Verwaltung, Tracking, Statistiken | + +--- + **Viel Spaß beim Tee-Tracken!** đŸ”âœš *Made with ❀ and JavaScript*