ressource_tracker

⚡ Verbrauchsdokumentation

Moderne Webapp zur Dokumentation von Strom-, Wärmepumpen- und Wasserverbrauch sowie Außentemperatur mit Multi-User-Unterstützung.

✨ Features

• 📊 Zählerstände erfassen für:
  • Haushaltsstrom (kWh)
  • Wärmepumpe (kWh)
  • Wasserverbrauch (m³)
  • Außentemperatur (°C)
  • Mülltonnen-Dokumentation (🗑️ Restmüll, Gelber Sack, Papier, Biomüll)
• 👥 Multi-User-Unterstützung mit vollständiger Datenisolierung
• 🔐 Benutzerregistrierung ohne Admin-Berechtigung
• 📈 Automatische Verbrauchsberechnung und Visualisierung
• 🌓 Dark Mode mit persistenter Speicherung
• 🎭 Demo-Modus zum Testen ohne Datenänderungen
• 📱 Tablet-optimierte UI mit 3 Slides:
  • Slide 1: Aktuelle Werte + Eingabe + Letzte Ablesungen
  • Slide 2: Interaktive Diagramme (7 Tage, 30 Tage, Monate)
  • Slide 3: Filterbare Datentabelle mit Suchfunktion
• 📋 Smart-Reminder für regelmäßige Ablesungen
• ℹ️ Info-Modal mit Zählerdetails per Klick

🛠 Technologie-Stack

Backend:

• Node.js + Express.js
• SQLite3 mit optimierten Queries
• JWT-Authentifizierung
• RESTful API

Frontend:

• Vanilla JavaScript (ES6+)
• Chart.js für Datenvisualisierung
• Responsive CSS Grid/Flexbox
• PWA mit Service Worker

🚀 Schnellstart

Lokal entwickeln

# Repository klonen
git clone [your-repo-url]
cd verbrauch

# Dependencies installieren
npm install

# Server starten
npm start

Die App ist verfügbar unter: http://localhost:3002

Produktionsdeployment

# Demo-Script kopieren und anpassen
cp deploy-demo.sh deploy.sh
nano deploy.sh  # Server-Details eintragen

# Deployment starten
./deploy.sh

Das Script führt automatisch aus:

• Dependencies-Installation
• Service Worker Version-Update
• Datei-Upload via rsync
• Apache-Konfiguration
• PM2-Neustart

Datenbank-Backup

# Demo-Script kopieren und anpassen
cp backup-db-demo.sh backup-db.sh
nano backup-db.sh  # Server-Details eintragen

# Backup ausführen
./backup-db.sh

🔧 API-Referenz

Authentifizierung

POST   /api/auth/login         # Login → JWT Token
POST   /api/auth/register      # Benutzerregistrierung
GET    /api/auth/check         # Token validieren
POST   /api/auth/logout        # Ausloggen
POST   /api/auth/setup         # Erster Admin (nur bei leerem System)

Datenmanagement

GET    /api/readings           # Alle Ablesungen (gefiltert nach user_id)
POST   /api/readings           # Neue Ablesung hinzufügen
DELETE /api/readings/:id       # Ablesung löschen
GET    /api/readings/latest/:type  # Neueste Ablesung pro Typ

Statistiken

GET    /api/stats/:type?days=7      # Verbrauchsstatistik Zeitraum
GET    /api/stats/:type?month=2&year=2026  # Monatsstatistik
GET    /api/available-months        # Verfügbare Datenzeiträume

Datentypen: household, heatpump, temperature, water, waste

💾 Datenbank-Schema

-- Benutzer-Tabelle
CREATE TABLE users (
    id INTEGER PRIMARY KEY,
    username TEXT UNIQUE NOT NULL,
    password_hash TEXT NOT NULL,
    first_name TEXT,
    last_name TEXT,
    created_at DATETIME DEFAULT CURRENT_TIMESTAMP
);

-- Ablesungen-Tabelle
CREATE TABLE readings (
    id INTEGER PRIMARY KEY,
    user_id INTEGER NOT NULL,
    type TEXT NOT NULL,              -- 'household','heatpump','temperature','water','waste'
    value REAL NOT NULL,             -- Zählerstand oder Messwert
    timestamp DATETIME DEFAULT CURRENT_TIMESTAMP,
    note TEXT,
    subtype TEXT,                    -- Untertyp (z.B. Müllart: 'restmuell', 'gelberSack', etc.)
    FOREIGN KEY (user_id) REFERENCES users (id)
);

📁 Projektstruktur

verbrauch/
├── server.js                    # Express-Server + API + Auth
├── verbrauch.db                 # SQLite-Datenbank (auto-generiert)
├── package.json                 # Dependencies & Scripts
├── deploy.sh                    # Produktions-Deployment (aus deploy-demo.sh erstellen)
├── backup-db.sh                 # Datenbank-Backup (aus backup-db-demo.sh erstellen)
├── deploy-demo.sh               # Deployment-Vorlage
├── backup-db-demo.sh            # Backup-Vorlage
├── bump-sw-version.js           # Service Worker Versioning
│
├── public/                      # Frontend-Assets
│   ├── index.html               # Haupt-App (3 Slides)
│   ├── login.html               # Login/Registrierung
│   ├── app.js                   # Frontend-Logik + Auth
│   ├── style.css                # Responsive Styling + Dark Mode
│   ├── manifest.json            # PWA-Manifest
│   └── service-worker.js        # Caching & Offline-Support
│
└── README.md                    # Diese Dokumentation

🎭 Demo-Modus

Integrierter Demo-Account für Tests und Präsentationen:

Login: demo / demo

Features:

• ✅ Vollständige UI-Funktionalität
• ✅ Realistische Winter-Testdaten
• ✅ Interaktive Diagramme
• ❌ Keine Schreibberechtigung (Read-Only)

Demo-Daten:

• Haushaltsstrom: 8-12 kWh täglich
• Wärmepumpe: 15-25 kWh täglich
• Außentemperatur: -5°C bis +8°C (Winter)
• Wasser: 2-4 m³ wöchentlich
• Mülltonnen: Zufällige Einträge verschiedener Müllarten

🔒 Sicherheit & Deployment

SSL-Zertifikat

ssh your-server
sudo certbot --apache -d your-domain.com

PM2 Process Management

pm2 status                # App-Status prüfen
pm2 logs verbrauch        # Logs anzeigen
pm2 restart verbrauch     # Neustart
pm2 monit                 # System-Monitor

Datenbank-Backup

# Automatisches Backup mit Zeitstempel
./backup-db.sh

🐛 Bekannte Probleme & Lösungen

Problem	Lösung
Diagramme zeigen 0-Werte	✅ SQL-Query korrigiert: Verbrauch = heutiger - gestriger Zählerstand
Service Worker cached alte Version	✅ Automatischer Version-Bump vor jedem Deploy
User-Daten vermischt	✅ Strikte user_id-Filterung in allen API-Endpoints

📈 Version History

v2.2.0 (Aktuell)

• 🗑️ Mülltonnen-Dokumentation hinzugefügt
• 📉 Mülltonnen-Diagramm mit Farb-Kodierung
• 💧 Wasserverbrauch-Durchschnitt korrigiert (berücksichtigt wöchentliche Ablesungen)
• 🔥 Temperatur-Eingabe vereinfacht (nur Außentemperatur)
• 📋 Tabellen-Integration für Mülltonnen-Auswertung

v2.1.0

• 🔧 Verbrauchsberechnung korrigiert
• 🧹 Codebase aufgeräumt
• 📝 Dokumentation überarbeitet

v2.0.0

• 👥 Multi-User-Support hinzugefügt
• 🔐 JWT-Authentifizierung implementiert
• 📊 SQL-Schema erweitert

v1.0.0

• 🎯 Initial Release
• 📱 Responsive UI
• 📈 Basis-Charts und Statistiken

📄 Lizenz

MIT License - Siehe LICENSE-Datei für Details.

---

🚀 Entwickelt für moderne Haushalte mit Smart Metering

This site is open source. Improve this page.