Skip to content

README.md

Latest commit

 

History

History
68 lines (50 loc) · 3.17 KB

README.md

File metadata and controls

68 lines (50 loc) · 3.17 KB
Raw

🍳 Flavr: Smart AI Pantry Chef

Deployed on Vercel React Vite Gemini

"Turn whatever you have in your kitchen into an extraordinary meal. No waste, no stress, just delicious food."

Flavr is a modern, high-performance web application designed to help home cooks—especially absolute beginners—create amazing dishes using whatever ingredients they currently have. Powered by Gemini 2.5 Flash using structured JSON output, the app evaluates pantry ingredients, checks for culinary safety, ranks recipes by feasibility, and offers detailed step-by-step instructions.

✨ Features

  • 🧠 Smart Pantry Input: Add custom ingredients or click common suggestions. Features instant autocomplete.
  • ⚠️ Redundancy & Duplicate Warnings: Intelligent string checks detect if you are adding singular/plural duplicates (e.g., "onion" vs "onions") or highly similar items, keeping your pantry list clean.
  • 🔬 AI Sanity Check: Before generating recipes, Gemini performs a validation phase to check if your ingredients can actually make a real, edible dish. It soft-nudges you if you put in junk inputs or incompatible items.
  • 📝 Detailed Recipe Cards: Includes estimated cook time, difficulty levels, cuisine classifications, nutritional summaries (approximate calories and protein), and ingredient matching (clearly showing what you have and what minimal extra items you might need).
  • 🔀 Ingredient Substitution Tips: Out of an ingredient? Gemini provides chef-curated substitution recommendations dynamically based on your recipe.
  • 👨‍🍳 Beginner-Friendly Instructions: Steps include explicit visual and sensory cues (e.g., "cook until the onions turn translucent and soft, about 5 minutes") rather than assuming prior culinary knowledge.

🛠️ Tech Stack

  • Frontend Framework: React 19 (Vite)
  • Styling & Theme: Tailwind CSS
  • Generative Core: Google Generative AI SDK (gemini-2.5-flash model)
  • Deployment Platform: Vercel

🚀 Getting Started

Prerequisites

Installation

  1. Clone the Repository:

     git clone https://github.com/byteWizard-zero/flavr.git
 cd flavr

  2. Install Dependencies:

    npm install

  3. Configure Environment Variables: Create a .env.local file in the root directory and add your API key:

    VITE_GEMINI_API_KEY=your_gemini_api_key_here

  4. Start Development Server:

    npm run dev

    Open http://localhost:5173 in your browser.

  5. Build for Production:

    npm run build