Skip to content

nicoryne/foodguard

Repository files navigation

🍽️ FoodGuard 🛒

For our CSIT327 course project, we are developing FoodGuard, a food waste management web application aimed at decreasing food waste. With this web-app, users can track the freshness of ingredients, manage them more effectively, and receive timely reminders before products expire. Additionally, users can integrate shopping lists to avoid unnecessary purchases, catalog ingredients, and get recipe suggestions based on what they already have, all through an easy-to-use interface.

📂 Repository Contents Overview

👥 Members

Full Name GitHub Profile
Matunog, Margaret Anne C. marginggg
Porter, Nicolo Ryne A. nicoryne
San Diego, Gabe Jeremy R. gabejeremy

🚀 Features

  • 🔐 User Authentication and Management

    • Provides secure login options for both registered users and guests. Registered users can save their data, while guest users can access core features temporarily. Users can also securely update their passwords and manage their account settings.
  • 🍽️ Personalized Ingredients Dashboard

    • Offers a dynamic home view displaying an overview of ingredients categorized by type (meat, fruits, vegetables, condiments) along with their freshness status.
  • 🔔 User Notifications

    • Users receive real-time notifications on updates from various features within the application, such as ingredients expiring, recipe book updates, and more.
  • 📖 Recipe Book Feature

    • Generates a list of recipe ideas based on the ingredients currently available in the user's inventory. Recipes are tailored to maximize the use of existing ingredients.
  • 🛍️ Shopping List Integration

    • Users can create and manage shopping lists based on their inventory needs and upcoming recipes.
  • 🗣️ Text-to-Speech Integration

    • Supports Text-to-Speech for hands-free dictation of ingredients and recipes.

🛠️ Installation Guide

Prerequisite: Ensure Python 3.0 or higher is installed on your system.

Step 1: Activate Virtual Environment

Activating a virtual environment ensures that the project runs with its own dependencies, isolated from other Python projects on your system.

source ./env/bin/activate

For Windows:

source ./env/Scripts/activate

Step 2: Install Dependencies

With the virtual environment, install all necessary Python packages in one using requirements.txt file.

pip install -r requirements.txt

Step 3: Start the Django Development Server

Run the Django development server to run the app locally.

python manage.py runserver

⚙️ Development Configurations

Django-SASS Watch Mode

Enables watch mode for django-sass which will watch for changes in the input.scss file and automatically compiles them into the output.css file.

py manage.py sass static/styles/input.scss static/styles/dist/output.css --watch

About

A food waste management web-application

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •