How danialkhilji/homeos works
HomeOS is a shared household dashboard for a kitchen touchscreen. A family member uses the React pages to manage tasks, shopping, notes, members, birthdays, and settings; the frontend’s API layer communicates with FastAPI, which exposes domain routes and persists household data in SQLite. The dashboard also presents calendar, prayer-time, and weather information. The source excerpts establish application routing, task interactions, and several backend service relationships; some feature wiring is documented only by the README or source index, so those connections are shown as unverified.
Main entry points: router.py Versioned API · App.tsx Page routing · main.py FastAPI application · service.py Member operations
Components 30
Touchscreen app
- Page routing
frontend/src/App.tsx - Dashboard
frontend/src/features/dashboard - Task page
frontend/src/features/tasks/TasksPage.tsx - Task queries
frontend/src/hooks/useTasks.ts - Task API client
frontend/src/api/tasks.ts - Shopping pages
frontend/src/features/shopping - Notes pages
frontend/src/features/notes - Settings pages
frontend/src/features/settings - Calendar pages
frontend/src/features/calendar - HTTP client
frontend/src/api/client.ts
API runtime
- FastAPI application
backend/app/main.py - Versioned API
backend/app/api/v1/router.py - Configuration
backend/app/core/config.py - SQLite session
backend/app/core/database.py - Background scheduler
backend/app/core/scheduler.py - Error handling
backend/app/core/exceptions.py - Data cleanup
backend/app/modules/cleanup/service.py
Household management
- Task domain
backend/app/modules/tasks - Task operations
backend/app/modules/tasks/service.py - Task records
backend/app/modules/tasks/models.py - Member management
backend/app/modules/members - Member operations
backend/app/modules/members/service.py - Member records
backend/app/modules/members/models.py - Shopping lists
backend/app/modules/shopping - Household notes
backend/app/modules/notes
Dashboard information
- Calendar and birthdays
backend/app/modules/calendar - Weather service
backend/app/modules/weather/service.py - Prayer times
backend/app/modules/prayer
Other components
- Family member
- Open-Meteo
Connections 43
- Family member → Page routing: uses
README.md - Page routing → Dashboard: routes to
frontend/src/App.tsx - Page routing → Task page: routes to
frontend/src/App.tsx - Page routing → Shopping pages: routes to
frontend/src/App.tsx - Page routing → Notes pages: routes to
frontend/src/App.tsx - Page routing → Settings pages: routes to
frontend/src/App.tsx - Task page → Task queries: uses
frontend/src/features/tasks/TasksPage.tsx - Task queries → Task API client: calls
frontend/src/hooks/useTasks.ts - Task API client → HTTP client: uses
frontend/src/api/tasks.ts - HTTP client → Versioned API: requests
- FastAPI application → Versioned API: mounts
backend/app/main.py - FastAPI application → Configuration: reads
backend/app/main.py - FastAPI application → SQLite session: disposes
backend/app/main.py - FastAPI application → Background scheduler: starts and stops
backend/app/main.py - FastAPI application → Error handling: registers
backend/app/main.py - Versioned API → Task domain: registers
backend/app/api/v1/router.py - Versioned API → Member management: registers
backend/app/api/v1/router.py - Versioned API → Shopping lists: registers
backend/app/api/v1/router.py - Versioned API → Household notes: registers
backend/app/api/v1/router.py - Versioned API → Calendar and birthdays: registers
backend/app/api/v1/router.py - Versioned API → Weather service: registers
backend/app/api/v1/router.py - Versioned API → Prayer times: registers
backend/app/api/v1/router.py - Task domain → Task operations: delegates
backend/app/modules/tasks/router.py - Task operations → Task records: queries
backend/app/modules/tasks/service.py - Task operations → Member operations: verifies member
backend/app/modules/tasks/service.py - Member management → Member operations: delegates
backend/app/modules/members/router.py - Member operations → Member records: queries
backend/app/modules/members/service.py - Member operations → Task records: unassigns
backend/app/modules/members/service.py - Member operations → Household notes: clears authors
backend/app/modules/members/service.py - Task records → SQLite session: uses
backend/app/modules/tasks/models.py - Member records → SQLite session: uses
- Weather service → Open-Meteo: fetches forecast
backend/app/modules/weather/service.py - Weather service → Configuration: reads settings
backend/app/modules/weather/service.py - Dashboard → Weather service: displays
- Dashboard → Prayer times: displays
- Dashboard → Calendar pages: displays
- Shopping pages → Shopping lists: requests data
- Notes pages → Household notes: requests data
- Settings pages → Member management: manages
- Calendar pages → Calendar and birthdays: requests data
- Data cleanup → Task records: cleans
backend/app/modules/cleanup/service.py - Data cleanup → Household notes: cleans
backend/app/modules/cleanup/service.py - Data cleanup → Shopping lists: cleans
backend/app/modules/cleanup/service.py