Initial commit: Cat Sitting Planner with PWA, SQLite, and Webhook Notifications
This commit is contained in:
42
README.md
Normal file
42
README.md
Normal file
@@ -0,0 +1,42 @@
|
||||
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.*
|
||||
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
||||
|
||||
## 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!
|
||||
|
||||
## Deploy on Vercel
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
||||
Reference in New Issue
Block a user