mirror of
https://github.com/taogaetz/chefbible.git
synced 2025-12-06 11:47:24 -05:00
50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
# ChefBible
|
||
|
||
## 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 so cooks can find, read, and add recipes in **under 10 seconds**.
|
||
|
||
The app is built with:
|
||
- **SvelteKit** for UI and server logic
|
||
- **TailwindCSS** for responsive, kitchen-friendly design
|
||
- **Prisma** as the ORM
|
||
- **PostgreSQL** as the database
|
||
|
||
This repo is intentionally structured to make onboarding **both humans and LLMs** easy, so all core context is documented here.
|
||
|
||
---
|
||
|
||
## Purpose
|
||
ChefBible aims to replace clunky recipe binders, scattered Google Docs, and slow web apps with something **built for the kitchen**.
|
||
It focuses on:
|
||
1. Storing and organizing recipes
|
||
2. Tracking ingredients and allergens
|
||
3. Building menus from recipes
|
||
4. Displaying everything in a **fast, easy-to-read format** on tablets or phones
|
||
|
||
**MVP Rule:**
|
||
If a feature isn’t needed for a cook to find, read, or add a recipe in **<10 seconds**, it is not part of Phase 1–2.
|
||
|
||
---
|
||
|
||
## Core Features
|
||
|
||
### Recipes
|
||
- Name, description, instructions, optional photo
|
||
- Linked ingredients (with quantity/unit/prep notes)
|
||
- Automatic allergen mapping from ingredients
|
||
- “Kitchen Mode” for step-by-step cooking view
|
||
|
||
### Ingredients
|
||
- Unique name
|
||
- Linked allergens
|
||
- Linked to recipes via `RecipeIngredient`
|
||
|
||
### Allergens
|
||
- Name + optional description
|
||
- Linked to ingredients
|
||
|
||
### Menus
|
||
- Name + optional season
|
||
- Contains recipes in sortable order
|