81 lines
2.9 KiB
Markdown
81 lines
2.9 KiB
Markdown
# 🐈 Katzen-Sitting-Planer (Cat Sitting Planner)
|
||
|
||
Der **Katzen-Sitting-Planer** ist eine simple, aber effektive Web-App zur Koordination der Katzenbetreuung während der Urlaubszeit. Anstatt unübersichtlicher Chat-Gruppen bietet die App einen zentralen Kalender, in dem sich Freunde, Nachbarn oder Sitter eintragen können.
|
||
|
||
---
|
||
|
||
## 🌟 Konzept & Philosophie
|
||
|
||
Die App folgt dem Prinzip **"Keep it simple"**:
|
||
- **Keine Registrierung erforderlich**: Sitter müssen kein Konto anlegen.
|
||
- **Passwortschutz**: Jeder Plan ist durch ein einfaches Gruppen-Passwort geschützt.
|
||
- **Fokus auf das Wesentliche**: Wer füttert an welchem Tag?
|
||
|
||
---
|
||
|
||
## ✨ Features
|
||
|
||
- 📅 **Zentraler Kalender**: Übersichtliche Darstellung des gesamten Zeitraums.
|
||
- <20>⬛ **Titel-Personalisierung**: Gib deinem Plan einen Namen (z.B. "Urlaub bei Lilly & Diego").
|
||
- 🌍 **Mehrsprachig**: Volle Unterstützung für Deutsch und Englisch.
|
||
- 🔔 **Webhook-Integration**: Erhalte sofort Benachrichtigungen via Discord oder Telegram bei neuen Buchungen oder Absagen.
|
||
- 📅 **iCal-Export**: Sitter können den Plan als Kalender-Abo (ICS) in ihr Handy integrieren.
|
||
- 🏠 **Besitzer-Status**: Markiere Tage, an denen du noch (oder schon wieder) zu Hause bist.
|
||
- 📝 **Instruktionen**: Hinterlege wichtige Infos (Futtermenge, Medikamente, Notfallnummern) direkt im Plan.
|
||
|
||
---
|
||
|
||
## 🚀 Bedienung
|
||
|
||
1. **Plan erstellen**: Wähle deinen Reisezeitraum, vergib einen Titel und ein Gruppen-Passwort.
|
||
2. **Link teilen**: Schicke den Link und das Passwort an deine Sitter.
|
||
3. **Eintragen lassen**: Sitter klicken einfach auf einen freien Tag, geben ihren Namen ein und bestätigen.
|
||
4. **Informiert bleiben**: Dank der Webhooks weißt du sofort, wenn ein Tag abgedeckt ist oder jemand absagen musste.
|
||
|
||
---
|
||
|
||
## <20>️ Technischer Stack
|
||
|
||
- **Framework**: [Next.js](https://nextjs.org) (App Router)
|
||
- **Datenbank**: SQLite mit [Prisma ORM](https://www.prisma.io)
|
||
- **Styling**: Tailwind CSS & Shadcn/UI
|
||
- **Benachrichtigungen**: Universelle HTTP-Webhooks
|
||
|
||
---
|
||
|
||
## 🔔 Notification Setup (Discord/Telegram)
|
||
|
||
Um Alarme zu erhalten, konfiguriere einen Webhook in den **Einstellungen** deines Dashboards.
|
||
|
||
### 👾 Discord
|
||
1. Gehe in deinem Discord-Server auf **Servereinstellungen** > **Integrationen** > **Webhooks**.
|
||
2. Erstelle einen **Neuen Webhook**, kopiere die **Webhook-URL**.
|
||
3. Füge diese URL in den Plan-Einstellungen ein.
|
||
|
||
### ✈️ Telegram
|
||
Am einfachsten via **Intergram**:
|
||
1. Suche in Telegram nach `@IntergramBot`.
|
||
2. Sende `/start`, um deine **Chat ID** zu erhalten.
|
||
3. Webhook-URL: `https://www.intergram.xyz/msg/DEINE_CHAT_ID`
|
||
|
||
---
|
||
|
||
## 🐳 Deployment (Docker)
|
||
|
||
### 1. Build & Run
|
||
```bash
|
||
docker-compose up -d --build
|
||
```
|
||
|
||
### 2. Datenpersistenz (Wichtig)
|
||
Die Daten liegen in `/app/data/dev.db`.
|
||
Mappe diesen Ordner unbedingt auf ein lokales Volume:
|
||
```yaml
|
||
volumes:
|
||
- /pfad/zum/host/data:/app/data
|
||
```
|
||
|
||
---
|
||
|
||
*Erstellt mit ❤️ für alle Dosenöffner.*
|