Skip to content

A recipe-finding website that leverages ingredients you have in your kitchen!

License

Notifications You must be signed in to change notification settings

pranavs2001/Insta-Chef

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub license

Insta-Chef is a website that enables you to discover new recipes for your culinary desires, using ingredients you already have in your kitchen!

Screenshots from the Insta-Chef website

  • The Search tab

Search tab

  • The Favorites tab

Favorites tab

  • The Pantry tab

Pantry tab

  • The Profile Tab

Profile tab

  • The Homepage

Homepage tab

Installation

The easiest way to run this project is to run it locally. Installation can be done with the following three shell commands

git clone https://github.com/pranavs2001/Insta-Chef
cd Insta-Chef
npm install

Once the install has completed, the app can be started using this command from inside the Insta-Chef repository

npm start

This should open up a window in your preferred browser running the Insta-Chef app.

Supported Browsers

Note that not all browsers have been tested. The following browsers have been tested:

  • Chrome
  • Brave
  • Edge
  • Safari
  • Firefox

Using the App

All users must be signed in to use the app. If a user is not signed in, they will be prompted to either sign in or create an account An email and password are necessary to create an account. The password must be at least 6 characters.

Once a user has created an account, they will be able to:

  • Save ingredients to their pantry
  • Save recipes to their list of favorites
  • Organize their pantry into categories

The categories in a user's pantry can be defined by the user. However, every user has an "Other" category that acts as the default. Also note that a user must save an ingredient to a category after they create it in order to have it saved as a member of their list of categories.

Servicing Firebase

NOTE: service account credentials are needed to perform this maintenance. Service account credentials need to be provided by a manager of Firebase.

The list of valid recipes is stored in Firebase to decrease lookup time. From time to time, it may be helpful to update the list of recipes stored in Firebase Perform the following commands from inside the top level Insta-chef repository to do this.

cd src/support
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python mealdbparser.py

This script pulls recipes for each category and area, and stores all recipes together. It prints out each category and area as it reads them. If the script is successful, the last line printed out will be

Firebase successfully updated

About

A recipe-finding website that leverages ingredients you have in your kitchen!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published