{"id":29098262,"url":"https://github.com/K0IN/Notify","last_synced_at":"2025-06-28T14:38:19.899Z","repository":{"id":36994415,"uuid":"405401947","full_name":"K0IN/Notify","owner":"K0IN","description":"A small deno deploy / self hosted solution to send web push notifications with webhooks","archived":false,"fork":false,"pushed_at":"2024-12-12T20:54:43.000Z","size":3981,"stargazers_count":150,"open_issues_count":14,"forks_count":25,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-12T21:28:04.839Z","etag":null,"topics":["notifications","preact","push-notifications","pushnotifications","pwa","web-push","web-push-api","web-push-notification","web-push-notifications","webhook","webpush","webpush-notifications"],"latest_commit_sha":null,"homepage":"https://notify-demo.deno.dev/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/K0IN.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-11T14:34:44.000Z","updated_at":"2024-12-12T20:48:48.000Z","dependencies_parsed_at":"2023-10-05T01:32:18.130Z","dependency_job_id":"28d54f44-8d4b-4413-9ab9-c0f588978e25","html_url":"https://github.com/K0IN/Notify","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/K0IN/Notify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/K0IN%2FNotify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/K0IN%2FNotify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/K0IN%2FNotify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/K0IN%2FNotify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/K0IN","download_url":"https://codeload.github.com/K0IN/Notify/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/K0IN%2FNotify/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262447254,"owners_count":23312734,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["notifications","preact","push-notifications","pushnotifications","pwa","web-push","web-push-api","web-push-notification","web-push-notifications","webhook","webpush","webpush-notifications"],"created_at":"2025-06-28T14:38:14.159Z","updated_at":"2025-06-28T14:38:19.888Z","avatar_url":"https://github.com/K0IN.png","language":"TypeScript","readme":"# Introducing Notify: Your Awesome Offline Push Message Sender! 📲\n\nLooking for a super-easy way to send push messages to your devices, even when you're offline?\nMeet Notify - the open-source project that's got your back!\nWith Notify, you can send push messages via a webhook to any device that supports web push.\nWhether you're using Docker, bare metal, or Deno Deploy, Notify's got you covered!\n\n**Get Notified Anywhere, Anytime! 📲**\n\nAnd that's not all! Notify comes with a cool offline installable PWA, ensuring you never miss any important notifications - even when you're on the go!\n\n## Check Out the DEMO 🚀\n\nWant to see Notify in action? No problem! We've set up a [live demo instance](https://notify-demo.deno.dev/) on deno deploy. Try it out now! Just use this command to send a notification to all your devices:\n\n```bash\ncurl -X POST -H \"Content-Type: application/json\" -d '{\"title\":\"Hello\", \"message\":\"World\"}' https://notify-demo.deno.dev/api/notify\n```\n\n**Customize Your Notifications! ✨**\n\nYou're in control! Personalize your notifications with optional features like adding an icon:\n\n```bash\ncurl -X POST -H \"Content-Type: application/json\" -d '{\"title\":\"Hello\", \"message\":\"World\", \"icon\": \"https://via.placeholder.com/150\", \"tags\": [\"test\", \"server\"] }' https://notify-demo.deno.dev/api/notify\n```\n\n**Easy Installation - No Fuss! 🛠️**\n\nDon't worry about complicated setups. The installation documentation is right here to help you get started with Notify in no time! 📚\n\n👉 [Installation Documentation](doc/install.md)\n👉 [Api Documentation](doc/api.md)\n\n## Features 🎉\n\n- Send push messages to any device that supports web push\n- Easy installation with Docker, bare metal, or Deno Deploy\n- Offline installable PWA\n- Customize your notifications with optional features like adding an icon\n- Open-source and free to use\n- No registration required\n- Easy to use API\n\n## Quickstart using Docker 🐳\n\nI know this looks scary on first glance but i swear it makes sense.\n\n1. Generate your instance vapid key `deno run --unstable --import-map https://raw.githubusercontent.com/K0IN/Notify/main/app/backend/deno.json https://raw.githubusercontent.com/K0IN/Notify/main/app/backend/main.ts generate`\n2. Start the docker (fill in the vapid key from step 1.) `docker run -p 8787:8787 -e VAPID_KEY=\u003cvapidkey\u003e -e SUB=mailto:admin@admin.com -e SENDKEY=mypassword ghcr.io/k0in/notify:latest`\n3. Start sending notifications\n`curl -X POST -H \"Content-Type: application/json\" -H \"Authorization: Bearer mypassword\" -d '{\"title\":\"Hello\", \"message\":\"World\"}' http://localhost:8787/api/notify`\n\nby the way, you can also use the deno cli to send notifications \n\n`deno run --allow-net --unstable --import-map https://raw.githubusercontent.com/K0IN/Notify/main/app/backend/deno.json https://raw.githubusercontent.com/K0IN/Notify/main/app/backend/main.ts notify -r http://localhost:8787/api/notify -t test -m world --key mypassword`\n\n(which can be build into a single binary)\n\n```bash\ndeno compile --allow-net --unstable --import-map https://raw.githubusercontent.com/K0IN/Notify/main/app/backend/deno.json --output notify https://raw.githubusercontent.com/K0IN/Notify/main/app/backend/main.ts\n\n./notify notify -r http://localhost:8787/api/notify -t test -m world --key mypassword\n```\n\n## Need Help? 🤔\n\n- Refer to our great [documentation](doc/install.md)\n- Start a discussion on [GitHub Discussions](https://github.com/K0IN/Notify/discussions)\n- Open an [new issue](https://github.com/K0IN/Notify/issues/new)\n\n## Credits to the Amazing Developers! 🙏\n\nHuge shout-out to the talented folks who made this possible! We've built on the fantastic web push code from [gauntface](https://github.com/gauntface) and, not to forget, we use the [Google Icon Font](https://fonts.google.com/icons).\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FK0IN%2FNotify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FK0IN%2FNotify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FK0IN%2FNotify/lists"}