Commit `848c0ce289`

848c0ce289718bcc92626a5c82ef4b7759d96941

parent: 9c09f8705e

Unsigned

cmc <hello@cleberg.net> · 2026-08-31 22:39 UTC

Convert README.nfo to README.org (!1)

Section headings become org headings, indented command blocks become
src blocks, and column-aligned content stays in example blocks.

Layout: unified · split

README.nfo deleted −45

		@@ -1,45 +0,0 @@
1		┌──────────────────────────────────────────────────────────────┐
2		│ H U T C H - N O T I F Y [ KRZ ] krz.sh │
3		└──────────────────────────────────────────────────────────────┘
4
5		WHAT
6		backend for push notifications in hutch.
7
8		DOES
9		- register apns device tokens
10		- store notification subscriptions
11		- poll sr.ht for changes
12		- send pushes via apns
13
14		STACK
15		python (fastapi), sqlite, apns (http/2, token auth).
16
17		STATUS
18		early development. current scope: device registration and a test
19		push endpoint. planned: build, ticket, and inbox notifications.
20
21		RUN
22		python3.12 -m venv .venv
23		source .venv/bin/activate
24		pip install -r requirements.txt
25		uvicorn app.main:app --reload
26
27		ENV
28		create .env:
29
30		API_KEY=change-me
31		DATABASE_URL=sqlite+aiosqlite:///./hutch_notify.db
32		APNS_KEY_ID=
33		APNS_TEAM_ID=
34		APNS_BUNDLE_ID=
35		APNS_PRIVATE_KEY_PATH=
36		SRHT_TOKEN=
37
38		NOTES
39		- the ios app registers with apns and sends its token here.
40		- keep the apns .p8 key secure.
41		- event-driven eventually; the first version polls.
42
43		┌──────────────────────────────────────────────────────────────┐
44		│ krz.sh │
45		└──────────────────────────────────────────────────────────────┘

README.org added +43

		@@ -0,0 +1,43 @@
	1	#+title: hutch-notify
	2
	3	* what
	4	backend for push notifications in hutch.
	5
	6	* does
	7	- register apns device tokens
	8	- store notification subscriptions
	9	- poll sr.ht for changes
	10	- send pushes via apns
	11
	12	* stack
	13	python (fastapi), sqlite, apns (http/2, token auth).
	14
	15	* status
	16	early development. current scope: device registration and a test
	17	push endpoint. planned: build, ticket, and inbox notifications.
	18
	19	* run
	20	#+begin_src sh
	21	python3.12 -m venv .venv
	22	source .venv/bin/activate
	23	pip install -r requirements.txt
	24	uvicorn app.main:app --reload
	25	#+end_src
	26
	27	* env
	28	create .env:
	29
	30	#+begin_src conf
	31	API_KEY=change-me
	32	DATABASE_URL=sqlite+aiosqlite:///./hutch_notify.db
	33	APNS_KEY_ID=
	34	APNS_TEAM_ID=
	35	APNS_BUNDLE_ID=
	36	APNS_PRIVATE_KEY_PATH=
	37	SRHT_TOKEN=
	38	#+end_src
	39
	40	* notes
	41	- the ios app registers with apns and sends its token here.
	42	- keep the apns .p8 key secure.
	43	- event-driven eventually; the first version polls.

Commit 848c0ce289

Commit `848c0ce289`