Skip to content

yashhash2/RecipeRaven

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📘 RecipeRaven

📑 Table of Contents


🧾 Overview

RecipeRaven is a recipe-sharing and management platform where users can explore, create, and save recipes. It offers personalized recommendations, ingredient-based search, and step-by-step cooking instructions.


✨ Features

  • User Authentication & Profile Management
  • CRUD operations for Recipes
  • Tagging (e.g., Vegan, Dessert)
  • Ingredient-based Search
  • Favorite Recipes
  • Mobile-Responsive UI

🧰 Technology Stack

Frontend

  • React
  • Tailwind CSS

Backend

  • Node.js
  • Express.js
  • MongoDB + Mongoose

Authentication

  • JWT (JSON Web Tokens)

Infrastructure

  • MongoDB Atlas
  • Docker (optional)

🔁 Workflow

  1. Authentication

    • Register/login using email & password
    • JWT issued and stored in browser
  2. Recipe Management

    • Authenticated users can create, edit, delete, and view recipes
  3. Explore

    • View recent or trending recipes
    • Use tags/ingredients to filter
  4. Favorites

    • Users can save recipes to their profile

🧩 Installation

Prerequisites

  • Node.js v18+
  • MongoDB Atlas
  • npm or yarn
  • (Optional) Docker

Setup Instructions

# Clone the repo
git clone https://github.com/yashhash2/RecipeRaven.git
cd RecipeRaven

# Install backend dependencies
cd backend
npm install

# Install frontend dependencies
cd ../frontend
npm install

# Setup .env in /backend
MONGO_URI=your_mongodb_uri
JWT_SECRET=your_secret

# Start backend
cd ../backend
npm run dev

# Start frontend
cd ../frontend
npm run dev

🧪 Usage Guide

  • Access the app at http://localhost:3000
  • Register or log in using your credentials
  • Create and submit new recipes with ingredients and steps
  • Explore all available recipes and filter them by tags or ingredients
  • Save your favorite recipes for easy access later
  • Edit or delete your own submitted recipes

🪪 License

This project is licensed under the MIT License.
See the LICENSE file for details.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages