Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 2.71 KB

README.md

File metadata and controls

77 lines (54 loc) · 2.71 KB
Raw

Grains of Paradise

Turing 2103 FE Mod 2 Partner Project What's Cookin (Grains of Paradise). Deployment Link: Grains of Paradise

Table of Contents

Introduction

This is a recipe tracking application designed to be viewed on a mobile device although it can also be viewed on larger screens. Users can view a list of recipes, favorite recipes, and choose recipes to cook. Users can filter recipes by tag, and can search for recipes based on ingredients or recipe name.

Demonstration of Application

Users can scroll through a list of recipes alt text

Users can click on a recipe to learn more information about it alt text

Users can favorite recipes and view them later alt text

Users can unfavorite recipes alt text

Users can choose recipes to cook later and view those as well alt text

Users can search through all recipes/favorite recipes by recipe name or ingredient name alt text

Users can also filter recipes by tag alt text

Technologies

  • JavaScript
  • HTML
  • CSS
  • Mocha
  • Chai
  • Webpack
  • Fetch API

Setup/execution-instructions

  1. Clone copy of repo to your machine: git@github.com:tylrs/whats-cookin.git
  2. CD into the directory
  3. In the terminal, run npm install
  4. After that, in a different directory outside of the whats-cooking directory, clone this repo: git@github.com:turingschool/What-s-cookin--starter-kit-API.git
  5. CD into the directory then run npm install and then npm start
  6. In a different terminal, CD back into your whats-cooking directory
  7. Now run npm start and a link for the webpack will appear: http://localhost:8080/
  8. In your browser, set the view to iPhone X to see it in its mobile view.

Future Iterations

  • Adding a rating system for users to use on recipes they interact with
  • Choose to add recipes to cook on specific days of the week and see a calendar displayed with those recipes
  • Compare a user's pantry, which contains a list of ingredients, to each recipe, and see if they the right ingredients to make a recipe.

Original Assignment

Contributors