Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 2.44 KB

README.md

File metadata and controls

59 lines (41 loc) · 2.44 KB
Raw

Recipe Search App 🥗

Welcome to the Recipe Search App! This web application allows users to discover healthy and nutritious food recipes using Edamam's API. Whether you're a seasoned chef 👨‍🍳 or a culinary enthusiast 👩‍🍳, our app makes finding the perfect recipe a breeze.The app also provides information on the nutritional value of each recipe, including calorie count, breakdown, preparing various chart.

🔗 Project

Technologies Used

  • React.js
  • Bootstrap
  • Edamam's API
  • React
  • npm
  • Git Workflow
  • CSS
  • Vercel

Installation and Setup

To install and run this project on your local machine, follow the instructions for:

Clone the GitHub repository:

  • git clone https://github.com/yourusername/recipe-search.git

  • Navigate to the project directory: cd recipe-search

  • Install the required dependencies: Create a .env file in the root directory of the project and add your Edamam API credentials as follows: makefile REACT_APP_EDAMAM_APP_ID= REACT_APP_EDAMAM_APP_KEY= Start the development server: sql npm start

Features

The Recipe Search app includes the following features:

  1. Search for recipes based on ingredients, cuisine, meal type, and dietary restrictions View recipe details, including ingredients, instructions, and nutritional information.
  2. Save favorite recipes to a user's profile for easy access Create a shopping list for ingredients needed for a recipe
  3. View and edit user profile information

API Usage

The Recipe Search app uses the Edamam API to retrieve recipe and nutrition data. The API requires an app id and app key, which are passed in as environment variables.

To search for recipes, the app makes a GET request to the Edamam recipe search endpoint with the user's search query and any optional parameters (cuisine, meal type, dietary restrictions). The response includes an array of recipes, each with its own unique identifier (URI).

When a user selects a recipe, the app makes a second GET request to the Edamam recipe endpoint with the recipe's URI to retrieve detailed recipe and nutrition data. The response includes the recipe's ingredients, instructions, and a detailed nutritional breakdown.

Contributions

Contributions are welcome! Please create a pull request with any features or bug fixes.

License

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