Hagustin / GRUB

An app which is aim for homecooks collaborative nature to improve each others ideas of cooking. It is convinient and maybe the future cookbook everyone needed. It will cover a wide variety of audiences with on common desire, which is cooking.
MIT License
0 stars 0 forks source link

Project-1-Grub

Description

Grub is an app where like-minded individuals who have a passion for cooking can showcase and share their favourite recipes. Its aim is to provide homecooks with a place where they can collaborate on recipe ideas, provide ideas for improvement or suggestions for recipe changes. It covers a wide variety of audiences who hold a common desire - cooking!

Installation

To access the GRUB website go to: https://Hagustin.github.io/GRUB.

Usage

To create an account for first time users simply go to (../index.html) and click on the Register button. Then type in your username and password to gain access to the site.

Screenshot of Landing Page: (https://github.com/Hagustin/GRUB/blob/main/Assets/Images/landingpage.PNG)

Once successfully logged in you will find the Grub homepage (../html/home.html) showing navigation to the four (4) recipe categories: Breakfast, Lunch, Dinner, Dessert that you can click on to go to the recipe category. Additionally, you will find the navigation bar at the top that you can also use to navigate to My Recipes, My Favourite Recipes, and the Fellow Grubs - where you can invite your friends to try the Grub app an make their own contributions or connect with existing Grub app account holders (i.e. Fellow Grubs).

Screenshot of Home Page: (https://github.com/Hagustin/GRUB/blob/main/Assets/Images/homepage.PNG)

When you click on a Recipe Category you will find a selection of recipes for that specified category, for example the recipe category for desserts (../html/dessert_specific_page.html). You also have the opportunity to Add Your Own recipe to the Recipe Category by clicking on the "Add My Dish" button.

Screenshot of Recipe Category Page: (https://github.com/Hagustin/GRUB/blob/main/Assets/Images/recipe-category.PNG) Screenshot of Add My Dish: (https://github.com/Hagustin/GRUB/blob/main/Assets/Images/add-my-dish.PNG)

When on the desserts (or other recipe category) page (../html/lemon-raspberry-cheesecake.html), simply click on a recipe to view the recipe details. Once on the recipe page you will find a list of ingredients and instructions on how to make the recipe.

Screenshot of Lemon Raspberry Cheesecake recipe page: (https://github.com/Hagustin/GRUB/blob/main/Assets/Images/recipe.PNG)

Credits

Special thanks to our collaborators on this Project - secret GRUB foodies at heart!

Additional special thanks to our Mentor Nirakar Puri for his guidance and support.

License

Copyright (c) 2024 Henry Agustin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.