docs: add description, features and usage to README
This commit is contained in:
93
README.md
93
README.md
@@ -1,55 +1,80 @@
|
||||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
||||
# 🐈 Katzen-Sitting-Planer (Cat Sitting Planner)
|
||||
|
||||
## Notification Setup (Discord/Telegram)
|
||||
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.
|
||||
|
||||
To receive alerts when someone cancels a cat sitting slot, you can configure a Webhook in the **Settings** menu of your dashboard.
|
||||
---
|
||||
|
||||
## 🌟 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. Open your Discord server and go to **Server Settings** > **Integrations** > **Webhooks**.
|
||||
2. Click **New Webhook**, name it (e.g., "Cat Sitting Bot"), and select the desired channel.
|
||||
3. Click **Copy Webhook URL**.
|
||||
4. Paste this URL into the **Notification Webhook** field in the plan settings.
|
||||
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
|
||||
Telegram doesn't support simple Webhooks natively for users. The easiest way is using a bridge like **Intergram**:
|
||||
1. Open Telegram and search for the `@IntergramBot`.
|
||||
2. Send `/start` to get your unique **Chat ID**.
|
||||
3. Your Webhook URL will be: `https://www.intergram.xyz/msg/YOUR_CHAT_ID`
|
||||
4. Paste this URL into the **Notification Webhook** field in the plan settings.
|
||||
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`
|
||||
|
||||
*Note: The app sends notifications automatically whenever a booking is deleted.*
|
||||
---
|
||||
|
||||
## 🐳 Deployment (Docker)
|
||||
|
||||
The easiest way to host the Cat Sitting Planner is via Docker.
|
||||
|
||||
### 1. Build & Run
|
||||
```bash
|
||||
docker-compose up -d --build
|
||||
```
|
||||
|
||||
### 2. Persist & Backup Data (Important)
|
||||
All coordination data is stored in a single SQLite file at `/app/data/dev.db` inside the container.
|
||||
|
||||
To ensure your plans are safe:
|
||||
1. **Always map a volume** to `/app/data`.
|
||||
2. **Backups**: Simply copy the `dev.db` file from your host path (e.g., `/mnt/user/appdata/csp/dev.db`).
|
||||
3. **Upgrades**: As long as the volume mapping stays the same, your data will survive container updates.
|
||||
4. **Moving Systems**: If you move the app, copy your existing `dev.db` into the new host data folder **before** starting the container.
|
||||
|
||||
**Example `docker-compose.yml` volumes:**
|
||||
### 2. Datenpersistenz (Wichtig)
|
||||
Die Daten liegen in `/app/data/dev.db`.
|
||||
Mappe diesen Ordner unbedingt auf ein lokales Volume:
|
||||
```yaml
|
||||
volumes:
|
||||
- /mnt/user/appdata/csp:/app/data
|
||||
- /pfad/zum/host/data:/app/data
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
||||
*Erstellt mit ❤️ für alle Dosenöffner.*
|
||||
|
||||
Reference in New Issue
Block a user