56 lines
2.3 KiB
Markdown
56 lines
2.3 KiB
Markdown
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).
|
|
|
|
## Notification Setup (Discord/Telegram)
|
|
|
|
To receive alerts when someone cancels a cat sitting slot, you can configure a Webhook in the **Settings** menu of your dashboard.
|
|
|
|
### 👾 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.
|
|
|
|
### ✈️ 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.
|
|
|
|
*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:**
|
|
```yaml
|
|
volumes:
|
|
- /mnt/user/appdata/csp:/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!
|