Skip to content

aescorcia65/FlavorBot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

126 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🍽️ FlavorBot

FlavorBot is a modern, AI-powered desktop application built using JavaFX and integrates with the OpenAI API to help users generate creative and personalized recipes based on their preferences and available ingredients.


🚀 Features

  • 🔍 AI-Powered Recipe Creation: Enter available ingredients or dietary preferences and get unique recipes instantly.
  • 🧠 OpenAI API Integration: Uses natural language understanding to deliver structured and easy-to-follow recipes.
  • 📝 Structured Output: Recipes include an ingredient list, preparation steps, and estimated cooking time.
  • 💡 Suggestions & Variations: Offers creative twists and substitutions for dietary needs.
  • 🖥️ JavaFX UI: Smooth and responsive user interface for seamless desktop experience.

📸 Screenshots

image image image image image


🎥 Demo Video

Watch the full walkthrough and demo of the Recipe Generator App on YouTube:

Watch the video

This video showcases:

  • How to input ingredients and preferences
  • Generating recipes using the AI backend
  • Viewing structured results with ingredients, steps, and cook time
  • The responsive and user-friendly JavaFX interface

🛠️ Technologies Used

  • Java 17+
  • JavaFX 17+
  • OpenAI API (ChatGPT or GPT-4 based)

🔧 Installation Instructions

Prerequisites

  • Java JDK 17 or higher installed
  • Maven or Gradle (for dependency management)
  • An OpenAI API key

Clone the Repository

git clone https://github.com/yourusername/recipe-generator-app.git
cd recipe-generator-app

Configure the API Key

  1. Open the file src/main/resources/config.properties (or your environment config file).
  2. Add your OpenAI API key:
openai.api.key=your_openai_api_key_here

Alternatively, use environment variables if preferred.

Build & Run

With Maven

mvn clean install
mvn javafx:run

With Gradle

./gradlew run

🧪 How to Use

  1. Launch the app.
  2. Enter ingredients you have (e.g., "chicken, rice, garlic").
  3. Add optional dietary preferences (e.g., "gluten-free", "vegan").
  4. Click Generate Recipe.
  5. View the generated recipe with ingredients, steps, and cook time.

🛡️ Security Note

Ensure your OpenAI API key is kept private and do not commit it to source control.


🙋‍♂️ Author


🌐 Connect

For support or inquiries, please open an issue on GitHub.

Happy cooking! 👨‍🍳👩‍🍳

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages