Giter Club home page Giter Club logo

recipe-keeper's Introduction

Recipe Keeper

Created By Christopher Neal, Ella Tanttu, Curtis Brooks, Jeff Lai, & Kim Brannian

An application to search for and modify recipes.

Technologies Used

  • HTML
  • CSS
  • Bootstrap
  • Javascript
  • jQuery
  • webpack
  • npm

Description

This project was created for Epicodus bootcamp as our week 7 Team Week project. The application is for searching for and modifying recipes. The user can search for recipes, scale the recipes to the size they want, and then add ingredients to a shopping list.

Setup/Installation Requirements

  • Clone the GitHub repository or download and open the Zip on your local machine.

  • From the project directory, run npm install in the terminal to load necessary plugins and packages.

  • Run npm run start to start the application.

  • Alternatively, you can run npm run build and open dist/index.html in your preferred browser.

  • Or you can click here to visit the page on gh-pages.

  • To get an API key for Edamam, first sign up for a 'Recipe Search' account here. Once you are signed in, click on the 'Get an API key now!' tab in your account. Click 'view' on your 'Recipe Search API' application and copy the API key, as well as the App Key.

  • In the terminal from the project directory run touch .env to create an environment file.

  • Open .env in your prefered editor and insert APP_KEY= followed by the API key you copied, then insert APP_ID= followed by the app ID you copied.

  • For more options, please reference Edamam's recipe API documentation.

Known Bugs

With certain search terms, not many recipes load. e.g. 'apple' returns four recipes and breaks on the fifth result.

Future Updates

  • Add option to convert to metric or US measurements.

License

MIT Copyright (c) 2021 Christopher Neal, Ella Tanttu, Curtis Brooks, Jeff Lai, & Kim Brannian

Support and Contact Details

recipe-keeper's People

Contributors

curtisbrooks678 avatar christophermneal avatar kimberkay 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.