Skip to content

sergiopesch/weekly

Repository files navigation

Casa Weekly

Casa Weekly product screenshot

A family weekly meal planner for breakfast, lunch, and dinner ideas. It is designed around three goals:

  • keep meals nutritious and toddler friendly
  • reuse weekly groceries before buying more
  • make planning feel warm, quick, and family specific

Run

Open index.html in a browser.

No build step or package install is required.

Test

npm test

The test suite runs JavaScript syntax checks and a dependency-free Chromium end-to-end smoke test.

Useful maintenance commands:

npm run check   # syntax and static asset checks
npm run ci      # check plus browser smoke test
npm run smoke   # browser smoke test only
npm run banner  # refresh docs/assets/casa-weekly-banner.png from the real UI

npm run smoke and npm run banner use chromium by default. Set CHROMIUM_BIN if your browser binary has a different name.

DevOps

GitHub Actions runs static checks and the browser smoke test on pushes to the default master branch, pull requests, and manual workflow dispatches. The workflow uses read-only repository permissions, cancels superseded runs on the same ref, and has a 10-minute job timeout.

Dependabot checks GitHub Actions updates weekly.

What It Includes

  • 7-day calendar with breakfast, lunch, and dinner slots
  • meal swaps, shuffle, lock, and fill-open-slots controls
  • family dietary toggles and an avoid list
  • grocery basket with local ingredients
  • computed shopping list based on planned meals
  • grocery reuse score and shared-staple insight
  • per-week meal plans keyed by Monday week start
  • family learning for favourites, skips, and planning notes
  • friendly weekly helpers for grocery reuse, toddler fit, weekly rhythm, and learning
  • family settings for home style, household context, planning promises, and learned preferences
  • project-specific smart-pot favicon and web app manifest
  • markdown starter files in family-guide/ for the underlying guide structure
  • local browser persistence through localStorage

Framework

Casa Weekly is built as a local-first personalised planning loop:

  1. Guide: home style, household context, planning promises, and family learning
  2. Observe: groceries, week, meals, dietary needs, avoid list, and feedback
  3. Learn: favourites, skips, notes, and taste profile
  4. Plan: score meals and keep separate weekly plans
  5. Explain: show weekly helper cards and a family guide preview

See docs/FRAMEWORK.md for the full architecture and docs/AUDIT.md for the current project audit.

Family Guide Model

Casa Weekly uses a four-part family guide model, but keeps the app language simple:

  • family-guide/SOUL.md → Home style
  • family-guide/USER.md → Household
  • family-guide/AGENTS.md → Planning promises
  • family-guide/MEMORY.md → Family learning

These are standalone starter templates for this project. The app does not read or import settings from any other local system. It stores the live version locally in the browser and lets you preview or download a plain-text family guide from Settings.

About

Weekly meal planner helps you with your meal prep with personalized recipes according to your routine

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors