Skip to content

Shubh-Nisar/Recipe_Recommender

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Phase-4 (Group:2) Deltas Explained

https://github.com/Shubh-Nisar/Recipe_Recommender/blob/master/images/recipe-recommender-demo.mp4

STA(R) GEN: A STAR RECIPE GENERATOR πŸ”

RECIPE RECOMMENDER

Made With DOI GitHub issues open GitHub stars Github closes issues Build Status codecov Respost - Write comment to new Issue event Check the source code GitHub contributors Code Formatter and Syntax Check Style Checker and Prettify Code Greetings Lines of code GitHub code size in bytes

video1927628096.mp4

πŸ” Our motto: Eat good, Be Healthy, Stay Happy πŸ”

Recipe Recommender is an application that suggests you recipes based on the ingredients which are currently available. One of the most tedious tasks while cooking is figuring out what to cook with the ingredients that you, have rather than how to cook it. Our software aims to ease this dilemma by providing recipes for food items which you can make with the ingredients at your home.

Documentation

Recipe Recommender is a website that suggests users simple food recipes based on ingredients provided.

  • The interface can take multiple ingredients from user as an input.
  • The interface can also takes the type of cuisine the user wants.
  • For each recipe, we show the key ingredients, instructions and a sample image.
  • Upon user request we also send the list of recipes to the user.

Technology Stack

NodeJS React Express.js NPM Chai MongoDB HTML CSS

Key Software Requirements

Project Setup Steps:

Installation:

  • clone repository-

    git clone https://github.com/Shubh-Nisar/Recipe_Recommender.git
    
  • setup for frontend open terminal and navigate to the frontend folder and execute the following:

    npm install --force
    
  • 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]

IDE and Code Formatter

Work Flow

Login Page

Sign Up Page

Home Page

Search Recipe

Added time to cook and vegeterian filter

Search by ingredients

Add new recipe form

View Recipes with time to cook filter

Screenshot of users collection created in mongo

Screenshot of recipe collections in mongo

Preference Filter

Roadmap

Phase 4:

  • Overhauled the backend code for improved cleanliness and efficiency.
  • Established a well-structured database schema and models.
  • Implemented controllers and routes for smooth functionality.
  • Enhanced logging and CORS support with Morgan and Cors.
  • Instituted a robust authentication system with JSON web tokens.
  • Secured user passwords through encryption during sign-up.
  • Automated testing with Chai and Mocha, ensuring code quality.
  • Revamped the user interface for a seamless user experience.
  • Introduced a user signup page for adding new users.
  • Protected routes to restrict access for unauthenticated users.
  • Employed react-router-dom for organized page navigation.
  • Displayed all recipes on the home page.
  • Added a route for adding new recipes, including a budget filter.
  • Implemented recipe search functionality with user-defined filters.
  • Reorganized project folders to enhance code maintainability.
  • Cleaned up file extensions for consistency.
  • Incorporated basic form validation to enhance user input.
  • Utilized functional components and ES6 syntax, replacing older ES5 classes.
  • Leveraged React hooks and arrow functions for improved code readability.
  • Utilized styled-components for styling the user interface.

Scope of improvement:

  • Add more filters and also recommend restaurants to users based on their inputs.
  • Use additional datasets to enhance results.

πŸ“„ 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.

Contributors


Tanishq Todkar

Shubh Nisar


Tanay Gandhi


Neel Dudehliya

Acknowlegements

We would like to thank Professor Dr. Timothy Menzies for helping us understand the process of building a good Software Engineering project. We would also like to thank the teaching assistants San Gilson, Andre Lustosa, Xueqi (Sherry) Yang, Yasitha Rajapaksha and Rahul Yedida for their support throughout the project. We would also like to extend our gratitude to previous group: (https://github.com/thosaniparth/Recipe_Recommender)

Made with ❀️ on GitHub.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 77.0%
  • HCL 11.6%
  • CSS 9.3%
  • HTML 2.1%