Skip to content

grow-with-code/Recipe-Hub

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🍲 Open Recipe Hub

Open Recipe Hub is an open-source web application where users can share, discover, and rate recipes.
It’s designed to be beginner-friendly and open for contributions during Hacktoberfest and beyond.


📌 Project Overview

The project allows users to:

  • Submit and store recipes (ingredients, steps, images).
  • Search recipes by ingredient, category, or difficulty.
  • Rate and favorite recipes.
  • Explore a collaborative hub of user-contributed cooking ideas.

🔹 Core Components

  • API (FastAPI backend)

    • Handles recipe submission, retrieval, and search.
    • Provides authentication and user profile endpoints.
  • Web UI (React + Tailwind)

    • User-friendly interface for browsing and submitting recipes.
    • Displays recipe details, ratings, and search filters.
  • Storage (SQLite / PostgreSQL)

    • Stores recipe data, user info, ratings, and media.

🔹 Request/Response Flow

  • /recipes → Add or retrieve recipes.
  • /search → Search by ingredients or filters.
  • /ratings → Rate or favorite a recipe.
  • /users → Manage authentication and profiles.

🔹 Data Models

  • Recipe: title, description, ingredients, steps, tags, image, created_by, created_at
  • User: username, email, password (hashed), joined_at
  • Rating: user_id, recipe_id, stars, comment, timestamp

🔹 Extensibility

  • Add new recipe categories (e.g., vegan, desserts).
  • Improve search functionality (full-text, filters).
  • Add social features (comments, sharing).
  • Multi-language recipe support.

🔹 Deployment

  • Local Development → Run backend (FastAPI) + frontend (React) with Docker or dev scripts.
  • Docker Compose → One command setup for API, Web, and DB.

🔹 Non-Functional Goals

  • Modular architecture (easy to extend).
  • Lightweight (runs locally with minimal setup).
  • Beginner-friendly contribution workflow.

🤝 Contributing

We welcome all contributors!

  • Fork the repo
  • Create a branch (feature/new-recipe-category)
  • Commit changes
  • Push and open a Pull Request

🚀 Getting Started

Clone the repository

git clone https://github.com/your-username/open-recipe-hub.git
cd open-recipe-hub

📢 Join Our Community

This project is open for everyone. Whether you are a beginner or experienced coder, you are welcome to contribute. Let’s learn and grow together! 🌱

Be a part of our growing community and stay connected 🚀

☕ Support the Project

If you like this project and want to support future development, consider buying me a coffee:


mgoshwami1c



About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 84.0%
  • JavaScript 6.9%
  • Python 4.6%
  • HTML 3.8%
  • Other 0.7%