From b0905697da251c05312333a13bffeca7ea238d99 Mon Sep 17 00:00:00 2001 From: taogaetz <59668529+taogaetz@users.noreply.github.com> Date: Fri, 15 Aug 2025 11:36:21 -0400 Subject: [PATCH] edit readme --- README.md | 107 +----------------------------------------------------- 1 file changed, 1 insertion(+), 106 deletions(-) diff --git a/README.md b/README.md index 7cb5e80..eb50c87 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Overview **ChefBible** is a self-hosted, mobile-friendly recipe and menu management tool designed for **real-world kitchen use**. -It is optimized for **speed**, **simplicity**, and **offline-friendly workflows** so cooks can find, read, and add recipes in **under 10 seconds**. +It is optimized for **speed**, **simplicity**, and so cooks can find, read, and add recipes in **under 10 seconds**. The app is built with: - **SvelteKit** for UI and server logic @@ -47,108 +47,3 @@ If a feature isn’t needed for a cook to find, read, or add a recipe in **<10 s ### Menus - Name + optional season - Contains recipes in sortable order - ---- - -## Data Model Summary - -plaintext -Recipe --(RecipeIngredient)--> Ingredient --(IngredientAllergens)--> Allergen -Menu --(MenuRecipe)--> Recipe -Tables: -Recipe: Core recipe info - -Ingredient: Basic ingredient info + allergens - -Allergen: Common allergen definitions - -Menu: Collection of recipes - -RecipeIngredient: Join table with quantity/unit/prep - -MenuRecipe: Join table with position - -UI Patterns -List + Detail -Recipes, ingredients, and menus use a consistent split layout: search/filter on one side, detail view on the other. - -Form with Inline Add -Add missing ingredients without leaving the recipe form. - -Tag/Chip Display -Allergens and prep notes shown as color-coded chips. - -Kitchen Mode -Large font, high contrast, step-by-step cooking instructions. - -Menu Builder -Drag-and-drop ordering of recipes in a menu. - -Global Search -Accessible from anywhere with / key shortcut. - -Development Phases -Phase 1 — Core Foundation -Local dev setup with repeatable builds - -Postgres + Prisma migration & seed - -Direct Prisma usage in +page.server.ts actions - -Phase 2 — Minimum Usable UI -CRUD for recipes, ingredients, menus - -Recipe form with ingredient selector + allergen auto-mapping - -Phase 3 — Internal Dogfooding -Fast search - -Menu builder - -Mobile-first adjustments - -Phase 4 — Stability & Shareability -JSON export/import for recipes - -Refined allergen mapping - -Search & filtering enhancements - -Local Development -Prerequisites -Node.js 20+ - -PostgreSQL 16+ (local or Docker) - -npm - -Setup -bash -Copy -Edit -git clone -cd chefbible - -npm install - -# Start Postgres (example using Docker) -docker compose up -d - -# Run migrations & seed -npx prisma migrate dev --name init -npx prisma db seed - -# Start dev server -npm run dev -Notes for LLMs -Framework: SvelteKit with Node adapter - -DB Layer: Prisma (/src/lib/server/db/*.ts contains reusable queries) - -Routing: Use +page.server.ts and form actions for now; no dedicated API routes until external consumers are needed - -UI: TailwindCSS utility-first design, mobile-first sizing - -Performance Requirement: All page loads & actions <500ms on LAN - -Design Priority: Minimal clicks, fast search, allergen visibility \ No newline at end of file