Skip to content

rickytang666/cheflow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CheFlow Logo

A comprehensive recipe management and cooking analytics platform


🎯 Overview

CheFlow is an interactive desktop application designed to revolutionize how you approach cooking and recipe management.

Built with Processing 4, it combines recipe storage, ingredient tracking, smart recommendations, and detailed cooking analytics to help users build better culinary habits and make informed grocery shopping and/or recipe decisions.

✨ Features

🥘 Recipe Management

  • Flexible Recipe Storage: Create and organize recipes with essential and optional ingredients
  • Duration Tracking: Set cooking time requirements for better meal planning
  • Recipe Search: Find recipes quickly with search functionality

🥗 Fridge Tracking & Smart Recommendations

  • Real-time Inventory: Keep track of ingredients you have at home
  • Matching Algorithm: Personalized recipe suggestions ranked by ingredient compatibility and time constraints
  • Priority Settings: Choose between ingredient availability and time constraints

📊 Analytics & Insights

  • Cooking Activity Visualization: Track cooking frequency and duration with scatter plots
  • Trend Analysis: Identify cooking habits and seasonal preferences using multiple math regression models including linear, polynomial, and exponential regression
  • Heatmap Analysis: Visualize cooking patterns over time just like GitHub's contribution graph

💻 Tech Stack

  • Language: Processing 4.3
  • GUI Framework: G4P (GUI for Processing)
  • Data Storage: JSON for persistent storages

🚀 Getting Started

Prerequisites

  • Processing 4.3 or later
  • G4P (GUI for Processing) library

Setup Instructions

  1. Clone the repository

    git clone https://github.com/rickytang666/cheflow.git
    cd cheflow
  2. Install Processing

    • Download Processing from processing.org
    • Install Processing and launch it
  3. Install Required Libraries

    • Open Processing
    • Go to SketchImport LibraryAdd Library
    • Search for and install G4P (GUI for Processing)
  4. Open the Project

    • Navigate to the CheFlow folder and open CheFlow.pde
  5. Run the Application

    • Click the play button to run the application

Usage

  • Recipes: Add recipes with essential/optional ingredients and cooking time
  • Fridge: Track your ingredient inventory for smart matching
  • Matching: Get recipe recommendations based on available ingredients and time constraints
  • Activities: Log cooking sessions and view analytics with heatmaps and trend analysis

Data is auto-saved in JSON format for easy backup and portability.

🤝 Contributing

Contributions are welcome! Please feel free to submit a pull request.

📄 License

This project is MIT licensed.


Built with 🍳 by Ricky
Empowering better cooking habits through tech

About

Smart recipe management app with ingredient matching, cooking analytics, and trend visualization

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published