Skip to content

Latest commit

 

History

History
86 lines (66 loc) · 2.47 KB

README.md

File metadata and controls

86 lines (66 loc) · 2.47 KB

Recipe Finder

Recipe Finder is a web application that allows users to search for recipes, view detailed recipe information, add recipes to their wishlist, and rate recipes.

Features

  • Search Recipes: Search for recipes by name.
  • View Recipe Details: View detailed information about a recipe, including ingredients, instructions, and a video tutorial.
  • Add to Wishlist: Add recipes to your wishlist for easy access later.
  • Rate Recipes: Rate recipes and view average ratings.

Technologies Used

  • Frontend: React, Axios, React Toastify
  • Backend: Node.js, Express
  • Database: MongoDB
  • API: TheMealDB API

ENV data

MONGO_URI
FIREBASE_DATABASE_URL
ADMIN
SUBSCRIPTION_KEY

Installation

  1. Clone the repository: 
    git clone https://github.com/your-username/recipe-finder.git
cd recipe-finder
  2. Install dependencies for backend 
    cd BackEnd
npm install
  3. Install dependencies for frontend 
    cd ../FrontEnd
npm install

Running the Application:

  1. Start the backend server: 
    cd BackEnd
npm start
  2. Start the frontend development server: 
    cd ../FrontEnd
npm start
  3. Open your browser and navigate to http://localhost:3000.

API Endpoints

  • GET /recipes: Fetch all recipes.
  • GET /recipe/:id/ratings: Fetch average rating for a recipe.
  • POST /wishlist: Add a recipe to the wishlist.
  • GET /wishlist: Fetch all recipes in the wishlist.
  • POST /login: Authenticate user and return a token.
  • POST /register: Register a new user.
  • GET /recipe/:id: Fetch details of a specific recipe.
  • POST /recipe/:id/rate: Rate a specific recipe.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

License

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

Acknowledgements

  • TheMealDB for providing the recipe data.
  • React Toastify for toast notifications.