Enhanced Recipe Recommender: Introducing additional features and addressing issues for an improved user experience.

Deployed Link: https://reciperecommendationsystem.vercel.app/

Watch how our application works:

Click here to watch - Youtube Video

What is Recipe Recommender?

Introducing Recipe Recommender—the smart solution to your cooking dilemmas! Our latest version is packed with new features designed to make your kitchen experience smoother, more interactive, and more personalized than ever.

With SSO Sign-In, logging in has never been easier or more secure—now you can access your account via social media or email with just a click. Our AI-Powered Recipe Suggestions take personalization to a new level, recommending dishes that fit your tastes and ingredients seamlessly. To make exploring recipes even more intuitive, we’ve introduced an Interactive Chatbot that offers three tailored options to help you find exactly what you’re craving. And, with an Enhanced UI and Bug Fixes, browsing and saving recipes is smoother than ever.

From personalized recommendations to a sleek, user-friendly design, Recipe Recommender is here to inspire your next delicious creation!

More about our new additions in our next section!

Feature additions: Enhancements, Upgrades and BugFixes:

Presenting our latest additions: Here's a comprehensive list of all our new features, enhancements, and upgrades!

1. User Profile: Our application now features Single Sign-On (SSO) authentication, allowing you to log in seamlessly through your social media accounts or by creating a new account within our system. This streamlined authentication process not only enhances security but also provides personalized experiences and customized access to your preferences and activities. Further details will be discussed in the following points. Your profile, information, and preferred recipes are now conveniently located in a designated area, simplifying the management of all your content in one organized space.
2. UI Refactoring: We’ve resolved multiple UI bugs, including issues with bookmark functionality and recipe cardholders, by removing inactive buttons and links. This thorough “system refactoring” has improved functionality and optimized the overall user experience.
3. Chatbot: We've introduced a Chatbot feature to enhance user engagement and make recipe discovery even more accessible. The chatbot serves as a virtual assistant, guiding you through various functionalities of our application directly from your messaging platform
4. We’ve integrated OpenAI to enhance our recipe recommendations, using artificial intelligence to provide smarter, more personalized suggestions tailored to your preferences.

Interaction Flows for Chatbot

1. Search Recipe by Name

   • Prompt: After /start, select the option to name a recipe.
   • Outcome: Receive step-by-step instructions if the recipe is available.

2. Find Recipes by Ingredients

   • Prompt: Provide the ingredients you have.
   • Outcome: Get suggestions for recipes you can make.

3. Access the Website

   • Prompt: Choose to open the website.
   • Outcome: Receive a link to our website.

Documentation and Project Flow:

1. User Registration and Authentication: A Universal sign in page, where you can create an account or sign up through any of you social media accounts
2. Search Recipes by Ingredients: Input your available ingredients to discover relevant recipes based on ingredient names.
3. Search Recipes by Dish Name: Locate recipes by specifying the dish name in the search.
4. Add a Recipe: Share details such as ingredients, dish name, time, cuisine, instructions, and optional images to contribute your recipe.
5. Bookmark Favorite Recipes: Save preferred recipes for easy access.
6. View Bookmarked Recipes in User Profile: Access and review all saved recipes conveniently stored under your user profile.
7. Logout: Securely Logout will again take you to our landing page, where you will be required to log in
   
   

Source documentation can be found at: Recipe Recommender Docs

API Documentation

Get Recipes: Retrieve a list of recipes based on specified filters like ingredients, cuisine, and page parameters. Success returns a code of 200 with the recipe list; error returns code 500 with an error message.

Get Recipe Cuisines: Fetches available cuisines, responding with a code of 200 and an array of cuisine strings on success. In case of an error, it returns a code of 500 with an error message.

Add Recipe: Allows users to add a new recipe via the /addRecipe endpoint, responding with a code of 200 and the inserted recipe's ID on success. In case of an error, it returns a code of 500 with an error message.

Get Ingredients: Retrieves a list of distinct ingredients through the /callIngredients endpoint. Success returns a code of 200 with an array of ingredient strings; error returns code 500 with an error message.

User Signup: Our application utilizes Auth0's APIs to provide Single Sign-On (SSO) authentication, allowing users to sign in through social media accounts or create a new account within our system. This integration supports various identity protocols, including OpenID Connect, OAuth, and SAML.

Get Bookmarks: Retrieves bookmarked recipes for a user through the /getBookmarks endpoint. Success returns a code of 200 with an array of bookmarked recipes; error returns code 500 with an error message.

Add Recipe to User Profile: Adds a recipe to a user's profile bookmarks via the /addRecipeToProfile endpoint. Success returns a code of 200 with the count of modified items; error returns code 500 with an error message.

OPEN AI API Suggests you recipe, powered by artifical intelligence.

Detailed documentation can be found at: API Docs

Technology Stack

Detailed documentation can be found at: TechStack Docs

Key Software Requirements

• Node.js v20.17.0
• NPM v10.8.2

Project Setup Steps:

Installation:

Check out our comprehensive YouTube video demonstrating each step for easy guidance. Project Setup

• clone repository using https://github.com/Software-Engineering-Folks/RecipeRecommender.git

• setup for frontend open terminal and navigate to the frontend folder and execute the following:

  npm install
  

• setup for backend open terminal and navigate to the backend folder and execute the following:

  npm install
  

  Execution Steps

1. start backend server using:

   npx nodemon
   

2. start frontend server using:

   npm start
   

3. Automatically a browser window is opened which shows frontend.
4. run npm test for running the tests [Dependencies: Jest, Chai, Supertest]

Release Made in this cycle

1. Major release 4.1 - Added SSO sign-in
2. Major Release 4.2 - Chatbot Integration
3. Major Release 4.3 - Major release- Included minor bug fixes and documentation updates
   

IDE and Code Formatter

• Visual Studio Code IDE
• Prettier Formatter for Visual Studio Code

📄 License

This project is licensed under the terms of the MIT license. Please check License for more details.

✏️ Contributions

Please see our CONTRIBUTING.md for instructions on how to contribute to the project by completing some of the issues.

FUTURE SCOPE

1. Nutritional Info: Show calorie counts and nutrition facts for each recipe.
2. Recipe Recommendations: Suggest similar recipes with a smart recommendation model.
3. Ingredient Price Comparison: Link ingredients to compare prices across multiple websites.
4. Smart Meal Planner: Automatically generate weekly meal plans and grocery lists based on user preferences and available ingredients.

Team Members

Annadurai,Harshitha
Bhoja Ramamanohara,Pannaga Rao
Masineni Prasanna Kumar,Karthik
Niranjana,Prathima Putreddy
Om Tandel, Snehil Behar, Devang Sarogi

Troubleshooting and Support

Common issues observed and solutions:

1. Occasionally, vulnerabilities may be detected in the backend. To address these, run npm install nodemon --save-dev, as npm audit fix --force may not resolve the issue.
2. The Auth0 login may occasionally experience callback errors if specific URLs aren’t specified on the application page. If you encounter this issue, ensure you add the hosting address to the allowed callback URLs. Facing other issues with the application? Mail us - software.72.engineering@gmail.com

Made with ❤️ on GitHub.