Forkify

A recipe search application made with javascript.
Explore the docs »

View Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Forkify is a vanilla JavaScript application that interacts with the Forkify API to fetch and display recipe food data. This app uses modern JavaScript tools, such as Webpack to bundle the modules, and Babel to convert ES6, ES7 and ES8 back to ES5. 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.

• HTML
• SCSS
• JavaScript
• Webpack
• NPM

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

Installation

1. Get a free API Key at Forkify API_KEY
2. Clone the repo

   git clone https://github.com/BarBronsthein/forkify-v2.git

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.

License

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

Acknowledgements

• Img Shields
• Netlify
• Webpack
• Google Fonts