Skip to content

gokul-koganti/Recipe_Recommender

Repository files navigation

DOI Made with GitHub issues open GitHub stars

Motivation

Screen Shot 2021-09-30 at 10 00 44 PM

An excerpt from " Diary of a hungry kid 😭"

One day my roommate and I went grocery shopping. My roommate has bought potatoes and frosting to make a weird dish for the next day's lunch. The next day, I woke up early at 2:07 pm to help my roommate with this dish, that I know nothing about, only to find him nowhere. He had gone to the library to work on his Software Engineering project. HOW SELFISH OF HIM? I AM LITERALLY STARVING HERE AND HE GOES OFF SOMEWHERE TO DO HIS PROJECT THAT IS SOON DUE ? 🤬🤬

After 1 hr of angry rants, I have realized that I should eat something to have a good siesta. But I didn't know what to cook. People always told me that cooking is a basic survival skill and I should learn to cook. I always took it for granted. Now I cannot order food from outside because I was broke after purchasing that super cool, absolutely unnecessary, formula 1 merchandize. That is when I thought, if only there is an app that could help me find recipes based on the ingredients I have in my pantry.


On a serious note

Cooking is a basic survival skill and it is more than standing infront of the stove and following instructions. Figuring out what to cook with what we have is equally. If we start cooking something that comes on top off our head, we might end up messing it when we find that an ingredient is missing. So we have decided to come up with an application that would help us breeze past the cooking process in this time-crunch world.

Documentation

Recipe Recommender is a website that suggests user simple food recipes based on ingredients provided. Currently,

  • Only one ingredients is considered
  • For each recipe, ingredients and instructions are shown

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

Technology Stack

NodeJSReactExpress.jsNPMJESTMongoDBHTMLCSS

Software Requirements

Project Setup Steps

  • clone repository using git clone https://github.com/gokul-koganti/Recipe_Recommender.git
  • setup for frontend open terminal and navigate to the frontend folder and execute npm install
  • setup for backend open terminal and navigate to the backend folder and execute npm install

IDE and Code Formatter

Execution Steps

  1. start backend server using npx nodemon
  2. start frontend server using npm start
  3. automatically a browser window is opened
  4. runnpm test for running the tests [Dependencies: Jest, Chai, Supertest]

Work Flow

Screenshot 2021-09-30 at 11 34 49 PM Screenshot 2021-09-30 at 11 35 17 PM Screenshot 2021-09-30 at 11 35 50 PM Screenshot 2021-09-30 at 11 36 37 PM Screenshot 2021-09-30 at 11 36 59 PM

Roadmap

Completed tasks

  1. Designed a User Interface using React JS library.
  2. Hosted the dataset on Mongo Database System.
  3. Performed querying and busniess logic implementation as part of backend module using Express JS library.
  4. Integration of backend and frontedn is done with the assistance of Axios library.

Future tasks

  1. Add filtering system based on cusine, Number of ingredients and calorie intake.
  2. Integrate the current dataset with review dataset(https://www.kaggle.com/sarthak71/food-recipes) and provide users with recipe ratings and reviews.
  3. Suggest nearby restaurants based on recipes generated.
  4. Provide recipe reccomendations based on multiple ingredients.
  5. Classify recipes into vegan / vegetarian / non-vegetarian categorizations.

Team Members