Skip to content

Latest commit

 

History

History
279 lines (228 loc) · 13.3 KB

README.md

File metadata and controls

279 lines (228 loc) · 13.3 KB
Raw

Phase-3 Deltas Explained

https://github.com/thosaniparth/Recipe_Recommender/blob/28f9f89192f8c438e2b1a9e706cdd6069a74cffb/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 Close as a feature Code Formatter and Syntax Check

Style Checker and Prettify Code Greetings Lines of code GitHub code size in bytes

Recipe_Recommender.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.

Source documentation can be found at: [Recipe Recommender Docs] https://github.com/thosaniparth/Recipe_Recommender/blob/master/docs/Recipe%20Recommender%20Source%20Documentation.pdf

Technology Stack

NodeJS React Express.js NPM JEST MongoDB HTML CSS

Key Software Requirements

Project Setup Steps:

Installation:

  • clone repository using git clone https://github.com/PvPatel-1001/Recipe_Recommender.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]

IDE and Code Formatter

Work Flow

Login Page

Search Recipe

Added time to cook and vegeterian filter

Search by ingredients

Add new recipe form

View Recipes

View recipes with time to cook

View Recipes with calorie information

View Recipes with diet-type information

Screenshot of recipe results receieved on email

Screenshot of users collection created in mongo

Screenshot of recipe collections in mongo

Roadmap

Phase 3:

  • Added users collection in the database for user accounts.
  • Developed User Interface and APIs for user authorization.
  • Implemented backend for saving recipe under user account.
  • Implemented application testing and code coverage.
  • Add option to choose total cooking time and display recipes which take less time than selected time.
  • Classify recipes into vegan / vegetarian / non-vegetarian categorizations.
  • Add login functionality.
  • Add feature to submit recipes so other people can view recipes.
  • Shown the time taken to prepare the recipe.
  • Shown diet type of recipe results.
  • Add a calorie/nutrients tracker.
  • Updated email format of the recipe results.
  • Fine tune the existing code and wrap up to produce a finished product.
  • Demo video showing deltas from phase-2 to phase-3.

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


Simran Bosamiya
Parth Thosani
Nisarg Shah
SharathKV

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 Xiao Ling, Andre Lustosa, Kewen Peng and Weichen Shi for their support throughout the project. We would also like to extend our gratitude to previous group: (https://github.com/PvPatel-1001/Recipe_Recommender)

Made with ❤️ on GitHub.