28 lines
1.5 KiB
Markdown
28 lines
1.5 KiB
Markdown
# FamilyHub
|
|
|
|
Self-hosted household management app: chores, points and leaderboards, reports, and wall-tablet kiosks, with Home Assistant and Discord integrations planned/partial.
|
|
|
|
**Repository:** https://gitea.hideawaygaming.com.au/jessikitty/family-hub
|
|
|
|
## Architecture
|
|
- **Backend:** FastAPI, SQLAlchemy, SQLite; APScheduler (must be started in FastAPI lifespan) for chore resets
|
|
- **Frontend:** React 18, TypeScript, Tailwind
|
|
- **Kiosk:** public (unauthenticated) pages for wall tablets; chore-first room → chore → "who did this?" flow
|
|
- **Deploy:** Windows host, `D:\Hosted\familyhub\`, `start.bat`; live DB at `backend\data\family_hub.db`
|
|
|
|
## Chore Model
|
|
- Completion log (Phase 3.1) drives reports, stats, leaderboards and verification
|
|
- Reset types: `weekly`, `fortnightly`, `monthly` (calendar-anchored, preferred); avoid `cooldown` for fixed-day chores
|
|
|
|
## Current State
|
|
- Phase 3.1 is the last pushed state
|
|
- Kiosk redesign, reset schedules, custom dashboards and room editor exist locally only; four migrations pending (order: reset schedules → dashboards → pet care split → rooms)
|
|
- README merge conflict unresolved
|
|
|
|
## Session Log
|
|
- 2026-02-05 — Phase 3.1 — Chore Completion Logging and Reports — Completion log, weekly/user stats API, verification, Reports page
|
|
- 2026-09-24 — Kiosk Redesign, Calendar Reset Schedules, Dashboards and Room Editor — Retrospective record of Aug 2026 local work; scheduler fix and four features awaiting migrations and push
|
|
|
|
---
|
|
*Created by: Jess Rogerson (yelling commands at Claude.AI)*
|