From 972abc197bafc995f65cf3a45b1d901675be3176 Mon Sep 17 00:00:00 2001 From: Christian Cleberg Date: Sun, 2 Aug 2026 15:29:32 -0500 Subject: convert readme to nfo; relicense to 0bsd --- README.md | 67 --------------------------------------------------------------- 1 file changed, 67 deletions(-) delete mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md deleted file mode 100644 index ec35961..0000000 --- a/README.md +++ /dev/null @@ -1,67 +0,0 @@ -# hutch-notify - -Minimal backend for push notifications in Hutch. - -## Purpose - -- register APNs device tokens -- store notification subscriptions -- poll sr.ht for changes -- send push notifications via APNs - -Designed to be: -- simple -- cheap to run -- easy to reason about - -## Stack - -- Python (FastAPI) -- SQLite (initially) -- APNs (HTTP/2, token-based auth) - -## Status - -Early development. - -Current scope: -- device registration -- test push endpoint - -Planned: -- build notifications -- ticket notifications -- inbox notifications (later) - -## Running locally - -```bash -python3.12 -m venv .venv -source .venv/bin/activate -pip install -r requirements.txt # or use pyproject - -uvicorn app.main:app --reload -``` - -## Environment - -Create an `.env` file: - -```bash -API_KEY=change-me -DATABASE_URL=sqlite+aiosqlite:///./hutch_notify.db - -APNS_KEY_ID= -APNS_TEAM_ID= -APNS_BUNDLE_ID= -APNS_PRIVATE_KEY_PATH= - -SRHT_TOKEN= -``` - -## Notes - -- iOS app must register with APNs and send device token to this server -- APNs key (`.p8`) must be kept secure -- Notifications are event-driven, but initial version uses polling - -- cgit v1.2.3