Git Product home page Git Product logo

stekatag / forkify Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 3.77 MB

Forkify is an application that uses the Forkify API to fetch and display recipe data. It utilizes modern tools such as Parcel and Babel and allows users to search for recipes, bookmark them, adjust serving sizes, and view detailed directions.

Home Page: https://forkify-stekatag.netlify.app

License: MIT License

HTML 24.68% JavaScript 29.92% SCSS 22.51% CSS 22.89%
forkify forkify-api forkify-project

forkify's Introduction


Logo

Forkify

A recipe search application made with Vanilla JS.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgements

About The Project

Product Name Screen Shot

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 Parcel to bundle the modules, and Babel to convert ES6+ features back to ES5.

Features

  • Search and save recipes
  • Adjust serving sizes
  • View nutritional info
  • Access original recipe website
  • Bookmark favorite recipes
  • Create shopping list
  • Make weekly meal plan

Built With

This app is built with Vanilla JavaScript, HTML and Sass. It's using Parcel 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

Installation

  1. Get a free API Key at Forkify API_KEY
  2. Clone the repo
    git clone https://github.com/stekatag/forkify.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.

  4. Create a shopping list of all the ingredients you need for your recipes to make grocery shopping easier and more efficient.

  5. Plan your meals for the week by selecting recipes and adding them to your weekly meal plan, helping you stay organized and save time.

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. Shopping list feature: button on recipe to add ingredients to a list. ✅

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

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

  5. Dark mode. ✅

  6. Responsive design. ✅

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AwesomeNewFeature)
  3. Commit your Changes (git commit -m 'Add some AwesomeNewFeature')
  4. Push to the Branch (git push origin feature/AwesomeNewFeature)
  5. Open a Pull Request

License

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

Acknowledgements

forkify's People

Contributors

dependabot[bot] avatar stekatag avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.