Recipe Lookup App

CSC207 Final Project

Contributor: Miguel Galang, Rolland He, George Qin, Alex Zhang (alphabetical)

Description

The Recipe Lookup App allows users to explore, manage, and create recipes through a personalized and user-friendly interface. Users can sign up, log in, and access features such as searching recipes, exploring by ingredients, bookmarking favorites, and even drafting their own recipes. Designed with accessibility in mind, the app provides seamless navigation and interactivity.

---

Table of Contents

1. Description
2. Features
3. Installation
4. Usage
5. Feedback and Contribution

---

Features

1. User Story 1: Account Management
   Users can sign up, log in, or log out of their own account. Upon signing up, they have the option to set their preferences for ingredients.

2. User Story 2: Homepage Overview
   Users see a homepage that contains all the use cases described below.

3. User Story 3: User Profile Access
   On the homepage, users can click on the profile button to view their username and their own recipes.

4. User Story 4: Recipe Recommendations
   The homepage displays three recommended recipes, each with a name and image, based on their chosen preference. Clicking on a recipe name redirects the user to an instruction page for that recipe.

5. User Story 5: Recipe Search Functionality
   Users can search for recipes by typing a keyword and clicking the search button. The results display all recipes that match the search query. Users can click on a recipe name to view its detailed instruction page. In the detailed instruction page, it will show whether it is alcoholic or not for accessibility use.

6. User Story 6: Explore Ingredients
   Users can explore recipes by ingredients using the "Explore Ingredient" button on the homepage. This displays a list of ingredients, and clicking on any ingredient shows all recipes containing that ingredient.

7. User Story 7: Bookmark Recipes
   Users can bookmark recipes on the detailed instruction page. Bookmarked recipes are then displayed on the homepage.

8. User Story 8: Create and Draft Recipes
   Users can create and draft their own recipes by selecting ingredients, describing instructions and giving the recipe a unique name. Created recipes are displayed on the user profile.

---

Installation

1. Clone the repository:

   git clone <https://github.com/shifosss/Final_Project.git>

2. Ensure Java is installed on your system (tested on Windows and MacOS).
3. Open the project directory in your terminal or IDE.

---

Usage

1. Run the main application file:

   java MainApp

2. Create an account by signing up.
3. Explore features from the homepage, including searching, bookmarking, and drafting recipes.

---

Feedback and Contribution

We welcome feedback to improve the app! If you encounter any issues or have suggestions, please contact us at:
📧 rolland.he@mail.utoronto.ca 📧 alexandar.zhang@mail.utoronto.ca

Optional contributions are also welcome. Feel free to fork the repository and submit pull requests for review.

---

License

MIT license. Shown beside.

---

Wriiten by Rolland He, 11.22