docs: refresh README + CLAUDE.md for current modules; add deploy guide for any Claude

- README/CLAUDE.md: Inventory depth (warranty/value/maintenance/sold/custom fields,
  HomeBox CSV import), Locations page, the two-world data-model rule, API-first +
  service-layer conventions, and the HTTPS-gated future work (MCP/PWA/camera)
- New docs/git-deploy-guide.md: self-contained git + deploy walkthrough for a
  Claude instance working without this repo's CLAUDE.md (NAS is a git checkout,
  push + pull/rebuild, never rsync, secrets in host .env, prisma-at-runtime gotcha)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-06-16 01:27:30 -05:00
parent 80324afea2
commit b8af0f986b
3 changed files with 134 additions and 9 deletions

View File

@@ -12,13 +12,18 @@ Live at **http://192.168.0.5:8053**.
reusable **plant types** (the "kind" record: care notes, sun/water, bloom &
harvest months, pet toxicity), Wikipedia photos, and plants placed on the shared
location tree.
- **Inventory** — durable **items** that nest (boxes within rooms within
buildings), with labels, attachments, and logs. Shares the same location spine
as the garden.
- **Animals** — pets & livestock with their own logs, placed on the shared
location tree; reminders can be linked to an animal.
- **Inventory** — durable **items** that nest (a toolbox holds the tools inside
it), with labels, photos + manuals/receipts/warranty docs, value & warranty
tracking (with expiry warnings), serial/brand, a sold record, and custom fields
(e.g. a vehicle's VIN). Schedule recurring **maintenance** per item. **Import
straight from HomeBox** via CSV. Shares the same location spine as the garden.
- **Animals** — pets & livestock with their own logs (feeding, vet, weight, meds)
and auto-computed age, placed on the shared location tree; reminders can be
linked to an animal.
- **Locations** — manage the whole place tree (areas, buildings, rooms, storage),
nested as deep as you like; everything (plants, items, animals) lives here.
- **Reminders** — one-off or recurring tasks (every N days / monthly / yearly),
optionally linked to a plant or animal.
optionally linked to a plant, item, or animal.
- **REST API** (`/api/v1/*`) — personal access **tokens** with per-scope
permissions (read plants, log harvests, …) for phone shortcuts, Home Assistant,
and automation.
@@ -69,7 +74,7 @@ Two ways to ship a change:
Do **not** rsync over the appdata dir — it would fight the checkout. Secrets
(`NEXTAUTH_SECRET`, `GITEA_TOKEN`, `UPDATER_SECRET`) live in a gitignored host
`.env` next to the compose file, never committed. Migrations apply automatically
on container start.
on container start. Full deploy walkthrough: [`docs/git-deploy-guide.md`](docs/git-deploy-guide.md).
## Conventions