jasmyn2244 / whats-cookin-starter-kit

What's Cookin

Mod 2

Table of Contents

• Abstract
• Technologies
• Illustrations
• Install + Setup
• Contributors
• Wins
• Challenges + Improvements
• Project Specs

Abstract

In this project, you will create a recipe tracking / meal planning application that allows users to view their favorite recipes and plan shopping trips around them.

Technologies

• Javascript
• eslint
• node
• Atom
• WebPack
• API
• Mocha and Chai
• Sass
• Lighthouse

Illustrations

• A user starts on the home view.
• They can select "All Recipes" to see the recipes displayed.
• Each recipe card has a heart and cookpot icon.
• When the heart is clicked, the recipe is added to the "Favorites" section and can be viewed by clicking, "View Favorites"

• When the cookpot is clicked, the recipe is added to the "To Cook" section and can be viewed by clicking the "To Cook" button
• When a user clicks "To Cook", each recipe indicates whether or not the user has enough ingredients in their pantry and gives the option to add the ingredients.

• In the "To Cook" view, the user also has the option to cook the recipes that they have the ingredients for in their pantry.
• When the user cooks a meal, the ingredients are subtracted from thier pantry.

• The user can view their pantry by clicking the "Pantry" button.

• To return to the home page, user can click the "home" button in the upper left hand corner.
• The user also has the ability to search and filter all recipes and favorited recipes by name ingredient or tag.

Install + Setup

• Fork and clone the repo down to your local machine
• cd into the directory
• Run npm install
• Run npm start and past the local host url in your browser
• To access the api, visit https://github.com/turingschool-examples/whats-cookin-api and clone it down to your machine
• cd into the directory
• Run npm install
• Run npm start

Contributors

• Kayla Durrett
• Jessica Organ
• Jasmyn Hicks

Wins

• We had a smooth workflow that allowed for consistent progress
• We met our goal to learn
• We accomplished the required functionality

Challenges + Improvements

• We discovered a problem in the data set and found a way around it by adding a conditional to our JavaScript.
• Future Iterations: We plan to implement a third party library. We could also include a rating system and a login page.

Project Specs

• The project spec & rubric can be found here