Skip to content
This repository has been archived by the owner on Mar 1, 2024. It is now read-only.

Latest commit

 

History

History
107 lines (73 loc) · 3.07 KB

README.md

File metadata and controls

107 lines (73 loc) · 3.07 KB
Raw

Forkify


A recipe search application made with javascript.


View Demo

About The Project

Forkify is a vanilla JavaScript application that interacts with the Forkify API to fetch and display recipe food data. The user can search for a specific recipe, and save to a favorites list via local storage. The user can easily increase or decrease servings as per his need and can view detailed directions.

Built With

This app is built with pure vanilla JavaScript along with HTML and SCSS. It uses webpack as module bundler and NPM as package manager.

Getting Started

To get started with project just simply fork this repo or download locally on your System.

To get a local copy up and running follow these simple example steps.

Prerequisites

Start with the latest version of NPM to avoid any errors:

  • npm 
    npm install npm@latest -g
  • Also install additional dependencies
 npm i --save core-js regenerator-runtime
 npm install @parcel/transformer-sass --save-dev

Installation

  1. Get a free API Key at Forkify API_KEY
  2. Clone the repo 
    git clone https://github.com/catherineisonline/forkify
  3. Install NPM packages 
    npm install
  4. Enter your API in config.js 
    const KEY = 'ENTER YOUR API';

Usage

  1. The Forkify Recipe App allows users to search for recipes.

  2. Users can view the recipe along with the cook time and also increase or decrease the amount of servings they need.

  3. Bookmarked recipes are stored in local storage so no database was required for this application.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Proposed features

  1. Number of pages between the pagination buttons.

  2. Ability to sort search results by duration or number of ingredients.

  3. Ingredient validation in view, before submitting the form.

  4. Improving recipe ingredient input: separate in multiple fields and allow more than 6 ingredients.

  5. Shopping list feature: button on recipe to add ingredients to a list.

  6. Weekly meal planning feature: assign recipes to the next 7 days and show on a weekly calendar.

  7. Nutrition data on each ingredient from spoonacular API (https:// spoonacular.com/food-api) and calculate total calories of recipe.

License

Distributed under the MIT License. See LICENSE for more information.