README.md

Buddy Documentation

This folder contains the project-level documentation for Buddy.

Start here

• Installing Buddy — run your own Buddy
• Screenshots — what every page looks like
• Architecture — C4 context and container diagrams
• Backend overview
• Users flow
• Calendars flow
• Groups flow
• Guardians flow
• Medicines flow
• Mealplans flow
• Pickups flow
• Task Library flow
• Progress flow
• Glossary
• HTTP status code semantics
• Health checks and observability
• Testing
• Setting up privacy for your Buddy — DPAs, backup rotation, record of processing, DPIA and privacy notice

Frontend

• Frontend overview
• Installing Buddy on a kid's iPad
• A single-day dashboard for the child home screen
• Historical meal plans and children's ratings
• Creating events across accessible calendars
• Task library
• Child calendar agenda
• Guardian calendar day, work-week, week, and month views
• Child progress and rewards
• Pickup planning and daily views

Backend design analysis

• Aggregate roots and their relationships
• Backend domain model diagram
• Group-owned calendars and permissions
• All-day calendar items
• Integration testing strategy
• Mutation testing strategy
• Validation rules
• Child accounts and guardian/parent roles
• Medicine schedules
• Meal plans
• Group-shared meal plans
• Meal plan iCal feed
• Pickup and drop-off schedules
• Guardian-managed child language
• Guardian-managed child time zone
• Gamified progress

Deployment

• Installing Buddy — install paths, the first guardian account, and every setting and command-line argument.
• Deploying to Oracle Cloud — production stack setup with Docker, Keycloak, PostgreSQL, and Caddy on an Always Free VM.

Scope

The documentation in this folder covers implemented backend and frontend behavior, domain and authorization decisions, testing strategy, and product analyses. App-specific development commands live in src/frontend/buddy/README.md, while local service setup is documented in the development container guide.