sam/where_woof
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README: add basic Mermaid structure map (renders on Gitea home)

Browse Source
This commit is contained in:
Sam Rolfe
2026-09-06 18:27:35 +10:00
parent ad8ee626fa
commit d3a2070aed
2 changed files with 28 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -2,6 +2,32 @@
Find your woof. A return-item tag platform (PetHub/ReturnMe style) — *"Where Woof !"* (a play on *werewolf*). Pre-coded QR/NFC tags on your dog, baggage, skis, etc. A finder scans the tag and sees exactly how to return it — call, text, or leave their number; location is shared with the owner when the finder allows. Find your woof. A return-item tag platform (PetHub/ReturnMe style) — *"Where Woof !"* (a play on *werewolf*). Pre-coded QR/NFC tags on your dog, baggage, skis, etc. A finder scans the tag and sees exactly how to return it — call, text, or leave their number; location is shared with the owner when the finder allows.
## Structure at a glance
```mermaid
flowchart LR
subgraph public["where-woof.com — public (Go + HTMX)"]
T[Tag QR/NFC] --> P["GET /t/:code"]
P --> S["POST /t/:code/scan"]
P --> C[finder contact]
O[/order/] --> BUY[Stripe Checkout]
end
subgraph admin["admin.where-woof.com — Laravel + Filament"]
A[Staff manage users/tags/orders/plans]
W["POST /webhooks/stripe"] --> D2["orders.status + tag transitions"]
end
subgraph core["Go frontend .13:3020"]
S --> G{"shouldAlert <br/> paid sub · SMS pool · caps"}
G -->|pass| SMS["SMSGlobal → owner phone"]
G -->|record| DB["Postgres .13:5434"]
end
BUY --> W
A --> DB
DB --> D2
```
*Interactive map:* [maps.lab.audasmedia.com.au/where_woof/docs/](https://maps.lab.audasmedia.com.au/where_woof/docs/diagrams/where-woof-flow.html) · *Source:* `docs/where-woof-flow.mmd`
## Status ## Status
GOAT front-end (Phase 1) built and verified — see `where_woof.md` for the full plan and roadmap. GOAT front-end (Phase 1) built and verified — see `where_woof.md` for the full plan and roadmap.

3
todo.txt
View File

@@ -31,4 +31,5 @@ x 2026-09-01 (A) Red promo banner on tag/about/contact/what-is-this pages +proje
x 2026-09-01 (A) Get in touch page: hello@where-woof.com + contact form +project:where-woof +agent:where_woof x 2026-09-01 (A) Get in touch page: hello@where-woof.com + contact form +project:where-woof +agent:where_woof
x 2026-09-01 (C) Verify coordinates in scan/location flow +project:where-woof +agent:where_woof x 2026-09-01 (C) Verify coordinates in scan/location flow +project:where-woof +agent:where_woof
(A) Go live: Stripe onboarding + live keys + live payment links +project:where-woof +agent:where_woof (A) Go live: Stripe onboarding + live keys + live payment links +project:where-woof +agent:where_woof
(B) hello@where-woof.com email routing (Cloudflare/SES) +project:where-woof +agent:where_woof x 2026-09-03 (B) hello@where-woof.com email routing (Cloudflare/SES) +project:where-woof +agent:where_woof
(B) SES production access approval + Cloudflare Email Routing (incoming hello@) +project:where-woof +agent:where_woof