Skip to content

Latest commit

 

History

History
117 lines (70 loc) · 7.75 KB

File metadata and controls

117 lines (70 loc) · 7.75 KB

Yummy User Manual

Team Puddlejumpers: Aaron Barthel, Lindsey Graham, Kenji Au, Tosin Olaniyi, Krisztina Pap


Quick Start Guide

Yummy allows users to plan their meals in advance, therefore saving them time and last-minute runs to the grocery store.

To properly install the application, please follow the steps described in the Yummy Installation Manual document or in the Yummy GitHub repository README file.

Main Yummy Features:

  • Site Navigation
  • User Profiles
  • Meal Plan
  • Recipes List
  • Recipe Details
  • Instructions/About Page

Yummy has a pop-out Site Navigation menu that can be accessed from any of the site’s pages by simply clicking on the button with the three horizontal lines (the “hamburger menu”) in the top left corner of the screen.

Yummy features an easy-to-use user profile management component and requires users to log in to ensure that recipes and meal plans stay private.

For ease-of-use, the Meal Plan screen serves a dual purpose. It shows what is already scheduled and allows users to edit their plans.

The Recipes page displays all the user’s recipes for easy browsing. Clicking on a title or picture will bring up the details of that recipe. Clicking on the trash can icon will delete that recipe.

In the spirit of maximum user-friendliness and transparency, the Yummy landing page includes information on both the application and the team who built it.

Main Features

Adding a Recipe

To add a recipe, just click on the menu in the top left corner (the “hamburger menu”) and choose Add a Recipe. There is an additional button on the Recipes page, for user convenience. To add one of your own recipes, all you have to do is be signed into your account, choose ‘Add a Recipe’ from the menu, and start filling out the Recipe Information fields. The mandatory fields (ones you must fill out to be able to save your new recipe) are marked with * symbols. Once you have reviewed your entry and are happy with it, just hit the Submit Query button at the bottom of the page. That is all!

Viewing Your Meal Plan

To view your meal plan, you can simply go to the menu in the top left corner of the screen (the “hamburger menu”) and choose the meal plan option.

Making a Meal Plan

First, add at least one recipe to your recipes list. You can do this by going to the top left corner of the screen (the “hamburger menu”) and choosing Add a Recipe or you can navigate to the Recipes page and click on the Add a Recipe button near the top of the page. Once you have recipes on your list, go to the meal plan screen by clicking on the menu button again, and selecting meal plan. On this page, you will see both your recipes and your current plan (looks like a calendar). If your recipes are not visible, click on the “Edit” button to enter Edit mode. Click on the recipe you want to add and then hold down your left mouse button and drag it over to your plan. You will be able to see the highlighting move as you hover over the individual meal slots. Once you are where you want to be, release the mouse button and the meal will drop into the appropriate slot. That is it!

Viewing a Recipe

To see the details of a recipe, go to the top left corner of the screen (the “hamburger menu”) and choose Recipes. Find the recipe you are interested in and click on its name, dietary details, or photo. You will be brought straight to the individual recipe’s details page.

Editing a Recipe

To edit a recipe, go to the top left corner of the screen (the “hamburger menu”) and choose Recipes. Find the recipe you are interested in and click on its name, dietary details, or photo. You will be brought straight to the individual recipe’s details page where you can click on the Edit Recipe button at the bottom left of the screen. Make your changes and click Save. Done!

Deleting a Recipe

Choose Recipes from the menu (the “hamburger menu” in the top left corner) to navigate to the Recipes page. Find the recipe you want to delete, and click the trash can icon on the right side of the recipe card. You will be prompted to confirm your intention to permanently delete the recipe from your list. Once you hit ‘Yes’, the recipe is gone!

Frequently Asked Questions

How do I create a meal plan?

First, add at least one recipe to your recipes list. You can do this by going to the top left corner of the screen (the “hamburger menu”) and choosing Add a Recipe or you can navigate to the Recipes page and click on the Add a Recipe button near the top of the page. Once you have recipes on your list, go to the meal plan screen by clicking on the menu button again, and selecting meal plan. On this page, you will see both your recipes and your current plan (looks like a calendar). If your recipes are not visible, click on the “Edit” button to enter Edit mode. Click on the recipe you want to add and then hold down your left mouse button and drag it over to your plan. You will be able to see the highlighting move as you hover over the individual meal slots. Once you are where you want to be, release the mouse button and the meal will drop into the appropriate slot. That is it!

Can I add my own recipes?

Yes! Yummy was created to provide people with a safe place to store their collections of tried and customized favourite recipes.

Who can see my recipes?

Only you! Yummy requires you to log in so all your recipes and meal plans remain private at all times.

How do I see my meal plan?

Just click on the menu button (top left corner of the screen) and choose the meal plan option!

How do I edit my meal plan?

Go to your meal plan by clicking on the menu button (top left corner of the screen) and choose the meal plan option. In edit mode, your recipes will be displayed above (on a small screen) or next to (on a large screen) your plan. If you can’t see your recipes, click on the ‘Edit’ button with the icon that looks like a small pad of paper with a pencil. This little button hides and reveals your recipe list! To edit your plan, you can click on a recipe, hold the left mouse button down, and drag it over to your plan. You will see the days and meals highlighting in blue as you drag over them. Find the slot you want to drop it in, and release the mouse button! And that’s it!

What if I dropped the meal into the wrong day/meal slot?

Don’t worry! You can click on the meal inside the plan, hold down your left mouse button, and drag it right over to the correct slot! You can even move it back into the recipe list if you decide not to include it in your meal plan after all!

Can I use the same meal more than once?

Of course! Once you have dragged a meal onto the plan and dropped it, the same meal will appear again in your recipe list!

Can I remove/delete a meal from my plan?

Yes! Just click on the meal, then hold your left mouse button down, and drag it back to the recipe list.

Can I delete a recipe?

Yes! Find the recipe you want to delete on your recipe list and click the Delete button (the icon that looks like a trash can). When prompted, confirm that you really wish to delete the recipe, and it will be gone!

Can I have more than one recipe list?

Yummy only supports one recipe list per user at this time.

Can I share my recipes with others?

Yummy does not support the sharing of recipes between users at this time.

What should I do if I can’t see my recipe list on the meal plan screen?

Don’t panic! You are just not in edit mode. Simply click on the ‘Edit’ button (looks like a small pad of paper with a pencil) right above the meal plan on the right side of the screen. This little button hides and reveals your recipe list!

Can I recover a deleted recipe?

Yummy does not currently support deleted item recovery.

Last Updated: December 8, 2020