Skip to content

STA(R) GEN: A STAR RECIPE GENERATOR- 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 re…

License

Notifications You must be signed in to change notification settings

het-patel99/Recipe_Recommender

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

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

Repository files navigation

STAR-GEN Demo Video (Deltas explained):

STARGEN_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 Running Code Coverage Style Checker and Prettify Code Greetings Lines of code Mark stale issues and pull requests 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/het-patel99/Recipe_Recommender/blob/master/docs/Recipe%20Recommender%20Source%20Documentation.pdf [Restaurant Recommender Docs] https://github.com/het-patel99/Recipe_Recommender/blob/master/docs/Restaurant_Recommendation.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/het-patel99/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

Previous Work

Current Work (Updated email format)

View Recipes

Database

Roadmap

Phase 3: Completed Tasks:

  • Added more filters and also recommend restaurants to users based on their inputs.
  • Added vegeterian/vegan filters, etc.
  • Hosted database on MongoDB server for better availability.
  • Added additional dataset to recommend restaurant as per the desired cuisine.
  • Made the webpage publicly available by hosting the website on AWS and reduced the down time to 0.
  • Added filter for rating recipe.
  • Dockerized the application.
  • Fine tuned the existing code and wrapped up to produce a finished product.
  • Changed email format of the recipe suggestions.
  • Added cooking time filter.
  • Improved the code test coverage by adding more specialized test cases.
  • Added demo video which shows how the user will interact with our software.
  • Added document for Phase-3 Improvements : https://github.com/het-patel99/Recipe_Recommender/blob/master/docs/Phase%203%20Improvements.pdf

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


Het Patel

Hardik Udeshi


Saloni Mahatma


Kalgee Kotak


Vineet Chheda

Made with ❀️ on GitHub.

About

STA(R) GEN: A STAR RECIPE GENERATOR- 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 re…

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 54.6%
  • HCL 17.3%
  • Python 12.9%
  • CSS 10.3%
  • HTML 3.1%
  • Dockerfile 1.5%
  • Shell 0.3%