Skip to content

Latest commit

 

History

History
111 lines (73 loc) · 2.99 KB

readme.md

File metadata and controls

111 lines (73 loc) · 2.99 KB

Forkify Recipe Search

Forkify Recipe Search is a web application that allows users to search for recipes and view their details. Users can also add their own recipes.

 

NOTE: NOT RESPONSIVE!!!

 

Mapty Banner

 

Features

  • Search for recipes using keywords.
  • View recipe details, including ingredients and cooking instructions.
  • Bookmark favorite recipes.
  • Add your own recipes to the database.

Technologies Used

  • HTML
  • CSS/Sass
  • JavaScript
  • Parcel (for bundling and building)
  • Babel (for JavaScript compilation)
  • Fraction.js (for handling fractions in ingredient quantities)

Getting Started

  1. Clone this repository to your local machine:
git clone <repository-url>
  1. Navigate to the top level of the cloned directory.
  2. Install dependencies:
npm install
  1. Start the development server:
npm  start

This will start a development server and open the application in your default web browser.

Usage

Search for recipes

  1. Enter a search term in the search field and click the search button.
  2. Click the pagination buttons to view more results.
  3. Click the recipe you want to view.
  4. Click the bookmark button to save the recipe to your bookmarks.

View recipe details

  1. Click the recipe you want to view.
  2. Click the bookmark button to save the recipe to your bookmarks.

Add your own recipe

  1. Click the add recipe button.
  2. Enter the recipe details.
  3. Click the upload button to add the recipe to the database.
  4. Click the bookmark button to save the recipe to your bookmarks.
  5. Click the close button to close the form.
  6. Click the close button to close the recipe.

View your bookmarks

  1. Click the bookmarks button.
  2. Click the recipe you want to view.
  3. Click the close button to close the recipe.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change :).

License

fell free to copy this project and use it for your own purpose

Project Status

This project is still under development. The following features will be added in the near future:

  • Number of pages between the pagination buttons.
  • Ability to sort search results by duration or number of ingredients.
  • Perform ingredient validation in view before submitting the form.
  • Improve recipe ingredient input: separate in multiple fields and allow more than 6 ingredients.
  • Shopping list feature: button on recipe to add ingredients to a list.
  • Weekly meal planning feature: assign recipes to the next 7 days and show on a weekly calendar.
  • Get nutrition data on each ingredient from spectacular API (https://spoonacular.com/food-api/docs) and calculate total calories of recipe.
  • Delete your own recipe.

Acknowledgements

This project was created as part of a web development course. Special thanks to the course instructors and mentors for their guidance and support.