Recipe Search Engine

Table of Contents

• Content Description
• Core_Features
• Installation
• Usage
• Demo/Site
• Q/A
• Contributing
• Technologies Used
• In Progress
• License

Content Description

Recipe Search Engine is a full stack application designed to help users find recipes based on ingredients, recipe names, or specific dietary preferences. This project is intended for personal use, which user can add recipes they wish in the database that is created upon the download of this application. Whether you're looking to cook with what's available in your kitchen or trying to find a new meal to try, this application makes recipe discovery easy and fast. With a user-friendly interface, it allows users to search, create, save recipes, and many more.

Core Features:

• Contains a core database inside the application
• Search recipe by name using the top search bar
• Search recipe by ingredients using the seconddary search bar, this process will recommend possible recipes given the ingredients the user enter.
• See all recipes currently stored in the database by tapping the "see all recipes" Button.
• User can create their custom recipe by clicking the "create recipe" button.
• User can toggle through different recipes by clicking through the buttons at the bottom.
• User can save and delete recipes that were created.
• More answers can be found in the Q/A section.

Installation

Follow these steps to set up the project locally:

1. Clone the repository:

   git clone https://github.com/Gallections/RecipeSearchEngine.git
   

2. Navigate to the src folder and find MainGUI in the ui sub folder.
3. Run the MainGUI file.
4. Now you have access to the User Interface of the application.

Usage

1. Use the search bars at the top to search for recipes either based on name or ingredients.
2. Set up your own database that stores personal recipes.
3. Create your personal recipes and save it to the database.

Demo/Site

Visit LINK for a video demonstation of the project

Q/A

1. Will this project be expanded to a larger database that allow user authentication and open the database for all users across the network? A: Yes, I have recently began to building upon this project, with plans to expand the scale of the database and add AI features.
2. Will the UI be improved? A: Yes, right now, the application is tailored for personal uses. I aim to turn this into a public full stack application.

Contributing

If you'd like to contribute to the project, follow these steps:

1. Fork the repository.
2. Create a new branch.
3. Commit your changes.
4. Open a pull request.

Technologies Used

In Progress

• Connecting a database using SpringBoot
• Create a front end using React
• Set up user authentication using jwt
• more to come...

License

This project is under the MIT License - see the LICENSE file for details.