Leftover

Leftover is way to digitally keep track of what ingredients you have availabe while simoultaneously viewing different receipes that tailors to what the user has available. This not only offers a conveinent way to keep track of what a user may have available when not in the house, but also helps prevent wasting food, and meal prepping, as well as what to purchase when grocery shopping.

Authors

• Dylan Goureau - @mastergoureau
  • Front end and Backend functionality (User, Recipe View)
• Brady Henderson - @bradyhendu
  • Front end and and Backend Functionality (Login, Register, and Homepage)
• Madeline Bramson - @madelinebramson
  • Front end and Backend functionality (Chef)
• Ryan Ly - @kaosu01
  • Front End and Backend functionality (Admin and cleanup)
• Nolan O'Rourke - @nolanorourke
  • Database creation and initialization (PostgreSQL)

Features

• Fullscreen mode
• Cross platform
• Functional database
• Desktop view
• Login / Logout functionality
• User input storage
• Role Based Access

Run Locally

Clone the project

  git clone https://github.com/mastergoureau/EPantry.git

Go to the project directory

  cd EPantry

  cd COP4521

  cd Leftover

Install dependencies

  npm install i

Install PostgreSQL Database with these Instructions and create an account

Important

Ensure that you remember your password, you will have to use these values to access your database and in the next step

Usage

First, navigate to the database folder (Epantry/COP4521/leftover/database/database.ini), and change the database.ini value in password to the password you use for PostgreSQL

Next, run the development server:

python3 server.py

Next populate the database

python3 setup.py

Finally, run the server

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

Interface

Supported Colors

The primary color is #396643, the secondary is #919e8e, and accent is #C0C0C0 The text color is #0f1310 The background color is #ffffff

Layout

Home Page

• Where the initial drop in point is for the program, where the user will start when they click on the link

Register Page

• Where the user will register their account, takes in first and last name, username, email, and password
• They can also say here if they are registering as a chef or as a regular user
• Provides link to login page if users doesnt have account

Login Page

• Returning users can log in to their accounts here
• Provides link to register page if user doesnt have account

User Home Page / Dashboard

• Displays all food availabe in the database, allows a user to add it to their pantry, then generates avilable receipes based on what is available in the recipes table.

Chef Page

• Has a dashboard as well, also has the ability to add recipes to the site
• On the recipe adding page, a chef is able to add ingredients and steps to their recipes
• Once added, the recipe is instantly available for all users

Reipe Page

• The recipe page lists all ingredients at the top, and all steps below it
• It also displays the name of the author of the recipe

Admin Page

• Admin page has the user dashboard as well, they are also able to revoke chef proviliges, and add food items to the database

Included Libraries

• flask_cors
• flask
  • Flask
  • redirect
  • jsonify
  • request
  • session
• config
• flask_jwt_extended
• hashlib
• datetime
• psycopg2
• configparser
• react
  • react-select
• next

Other Resources

• Tailwind
• PostreSQL
• NextJS
• React
• Node Package Manager

PostgreSQL Database Password Encryption

This application is made using the PostgreSQL database. To create a more secure login for our users, we used PostgreSQL's feature of roles/users. When the user registers an account for the site, the password is encrypted using MD5. For us to test and run the application, we need to change the password encryption method of the PostgreSQL database to MD5, as it defaults the SCRAM-SHA-256.

To change it on a MAC device:

• Open SQL Shell (Don't Close Shell Until Procedure is Complete and Functional)
• Type: SET password_encryption = 'md5';
• Reset Your postgres superuser's password (Now, Your Password for postgres Should Be Encrypted Using MD5)
• Open Terminal, Go to the Directory /Library/PostgreSQL/16/data (Again, Don't Close Terminal)
• Type sudo -su postgres, Then Type in Your MAC Login
• Edit the File pg_hba.conf (Preferably with VIM) by Changing All Instances of scram-sha-256 to md5, Save w/ :wq (if Using VIM)
• Edit the File postgresql.conf (Must Be VIM) by Changing scram-sha-256 on the Line '#password_encryption...' to md5 (Also Remove # in Front of password_encryption), Save w/ :wq!
  • As postgresql.conf isn't Supposed to Be Modified, It'll Most Like Tell You that You Can't Edit the File, and Exit the File, So Continue Trying (Should Take Only a Few Tries) Until Asked If You're Sure You Want to Edit the File, Type y for 'Yes.'
• Open Back Up the SQL Shell You Initially Opened, and Type SELECT pg_reload_conf();
• Open Up a New SQL Shell, and Login As You Normally Would
  • If Successful the 1st Time, Everything is Good to Go!; You Can Move onto Setting Up the Next.js Application
  • If Not, Make Sure the Files are Edited Correctly and Repeat the Steps From There

To change it on a Windows device (using PowerShell), the steps are the same, but you don't need to type sudo -su postgres, as sudo isn't a command on Windows. Also, editing tools like nano or vim don't work on Windows. Instead use notepad.exe <file_name> to edit the changes mentioned above.