Skip to content

chipanyanwu/YesChef

Repository files navigation

Contributors Forks Stargazers Issues project_license LinkedIn


Logo

YesChef: Your personal AI-powered sous chef.

YesChef is a web application that uses AI to help you cook.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License
  6. Contact

About The Project

Product Name Screen Shot

YesChef is an innovative website and app designed to assist users in the kitchen by providing hands-free cooking guidance. With voice input and output, users can interact with the app without touching a screen or keyboard—perfect for when their hands are dirty from cooking. Whether you're a beginner or an experienced chef, YesChef makes cooking easier and more efficient. A screenshot is shown above!

Features:

  • Voice Control: Ask for step-by-step instructions or clarifications without touching your device.
  • Hands-Free Operation: Voice input and output keep your hands free for cooking.
  • Interactive Recipe Guidance: Get real-time feedback and highlights of the current cooking step.
  • Ingredient List: View ingredients clearly and check them off as you go.
  • Cooking and Prep Times: See how long each step and the overall recipe will take.
  • Image Assistance: View images for extra clarification, ensuring you understand each step clearly.
  • Standardized Recipe Display: Recipes are beautifully formatted into a clean, user-friendly HTML page, making them easy to follow.
  • YesChef is the perfect cooking companion for those who want to focus on the art of cooking without constantly needing to touch or scroll through a device.

(back to top)

Built With

  • TypeScript
  • React
  • TailwindCSS
  • Vite
  • Firebase
  • GoogleAI

(back to top)

Installation

  1. Get a Gemini API key at Google AI Studio (API key docs)
  2. Clone the repo
    git clone https://github.com/chipanyanwu/YesChef.git
  3. Install NPM packages
    npm install
  4. Create a .env and enter your API key.
    VITE_GEMINI_API_KEY=<ENTER YOUR API>
  5. Check that it's working by locally hosting it
    npm run dev

(back to top)

Usage

Basic Workflow

  1. Start Session: Say or type "YesChef, give me a recipe for chocolate chip cookie" or type/paste in your recipe
  2. Cooking Mode: Follow step-by-step instructions

Note that image functionality is not merged into main. It can be found in the images branch and requires a Google API key and Search Engine ID to be set as VITE_GOOGLE_API_KEY, VITE_GOOGLE_SEARCH_ENGINE_ID in .env.

Roadmap

  • Core recipe generation functionality
  • Voice command integration
  • Image generation (not merged into main)
  • Integrated timers
  • "Hey Siri"-style voice activation
  • Pulling recipes from social media

(back to top)

Top contributors:

contrib.rocks image

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Chip Anyanwu - chibuezeanyanwu2025@u.northwestern.edu Brooks Hu - brookshu2026@u.northwestern.edu Davi Maciel - davimacieldias2025@u.northwestern.edu Theo Maurino - theomaurino2026@u.northwestern.edu Nick Qiu - nicholasqiu2026@u.northwestern.edu Yindi Zhao - yindizhao2026@u.northwestern.edu

(back to top)

About

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors