Skip to content

Latest commit

 

History

History
135 lines (89 loc) · 3.48 KB

README.md

File metadata and controls

135 lines (89 loc) · 3.48 KB

License: MIT


cook-helper

Table of Contents
  1. About The Project
  2. Getting Started

  3. License
  4. Contact

About The Project

ProductScreen Shot

Cook helper helps users to cook and organise cooking efficiently! You can select recipes to cook and add, edit and delete recipes to customize your Cook helper. You can view several recipes at the same time and see which ingredients you need. Each step can be collapsed so you can see how far you have cooked and multitask easily.

(back to top)

Built With

(back to top)

Usage

Following image shows this application's functionality. This is an image of the product.
Click here to view walk through video

To use this app, please create your account in sign up page.

[Recipes page] : you can view all recipes and click on the photo to view a recipe 
and edit its details by clicking the edit button and update.
Unwanted recipes can be deleted here. 
[Cooking page] : displays the recipes selected on the recipe page. 
Multiple recipes can be displayed.
All of the ingredients are displayed at the top so that you can plan your shopping quicker.
The instruction steps are collapsible, 
so you can hide finished steps and multitask easily when cooking!
[Create Recipe page] : This page allows you to create a new recipe. 
Fill in the fields according to your recipe. 
Ingredients and steps are adjustable, so you can add more or less. 
Recipe photos can be added from your PC, Instagram or Google Drive, unsplash etc.

Click here to view the Deployed app

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

The application will be invoked by using the following command:

1: Clone the repo

 git clone [email protected]:ayacomputer/cook-helper.git

2: Install the npm packages

npm i

3: Run the app

npm run develop

(back to top)

License

License: MIT

Distributed under MIT License.

See LICENSE.txt for more information.

(back to top)

Contact

Ayako Woollan - [email protected]

Project Link: https://github.com/ayacomputer/cook-helper

(back to top)