BiteBack

• develop branch:

• main branch:

Project Overview

This project aims to develop a mobile application that tackles food waste and food insecurity in NYC. It connects businesses, restaurants, and individuals with surplus food to users in need, promoting a more sustainable and equitable food system.

Problem Statement

• Food Waste: Businesses discard substantial amounts of surplus food daily, contributing to environmental and economic burdens.
• Food Insecurity: Many individuals and families, particularly in NYC's homeless population, face food shortages and limited access to healthy meals.

Target Users

• Business Owners: Restaurants, delis, and grocery stores with surplus food to donate or sell at discounted prices.
• Food Insecure Individuals: People seeking affordable or free food.
• Community Organizations: Groups that coordinate food drives or manage community fridges.
• General Users: Individuals offering extra food from events or looking for discounted food options.

Vision Statement

Our vision is to create a platform that fosters a strong community network by connecting surplus food sources with those in need. By facilitating food donation, reduced prices, and efficient food access, we strive to:

• Reduce food waste and its associated environmental and economic impacts.
• Combat food insecurity by providing access to nutritious food for underserved communities.
• Promote sustainability within the food system by encouraging resourcefulness and reducing waste.
• Cultivate a culture of community care by enabling businesses, individuals, and organizations to contribute to a more equitable and food-secure society.

Key Features

• Food Donations: Businesses/Restaurants/Users can list surplus food for donation
• Real-time food availability dashboard: Users can browse offerings from nearby businesses and individuals in real-time.
• Location-based search: Find nearby donation locations and discounted food options.
• Seamless communication: Users can coordinate food pickups or ask questions through messaging between the person picking up and the vendor or donor, not between donors or receivers.
• User Reviews and Ratings: Recipients can leave reviews and ratings for businesses and organizations, sharing their experiences to guide future users.
• Maps Integration: Locate nearby donation sites and community fridges with integrated Google Maps/similar maps for easy navigation.

Getting started with Development

Project Structure

.
├── .github/               # GitHub workflows and settings
├── system_design_docs/    # System design documentation
├── src/                   # Django application root
│ ├── accounts/            # Sub-application for register / login / accounts
│ ├── database/            # Database schemas
│ ├── donor_dashboard/     # Sub-app for donor management
│ ├── django_management/   # Main Django project folder
│ ├── recipient_dashboard/ # Sub application for reserving donations
│ ├── static/              # Static files (CSS, JS, images)
│ ├── templates/           # HTML templates for front-end
│ └── manage.py            # Django management script
├── README.md              # This file
├── requirements.txt       # Requirements to be installed with pip
├── .travis.yml            # Setup for Travis CI / CD
├── .djlintrc              # Setup for HTML linting and formatting
└── .flake8                # Setup for Python linting and formatting

Prerequisites

• Python 3.x
• pip (Python package installer)
• Virtualenv (optional but recommended)

Setup Instructions

1. Clone the repository

   git clone https://github.com/gcivil-nyu-org/wed-fall24-team5
   cd wed-fall24-team5

2. Set up a virtual environment:

   python3 -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies

   pip install -r requirements.txt

4. Run database migrations

   python src/manage.py makemigrations
   python src/manage.py migrate

5. Run development server

   python src/manage.py runserver

Development

Creating a new sub-application

1. To create a new subapplication, change to the src/ folder and use the built-in Django startapp feature

   cd src
   python manage.py startapp [subapplication_name]

2. Create a folder for the templates and static files for this subapplication.

   cd [subapplication_name]
   mkdir static templates templates/subapplication_name

3. Add the src/subapplication_name/urls.py file to the subapplication

   touch urls.py

4. Add the appropriate paths to the src/subapplication_name/urls.py file

   # Example src/subapplication_name/urls.py file
   from django.urls import path
   from . import views
   
   urlpatterns = [
      path('login/', views.login_view, name='login'),
      path('register/', views.register_view, name='register'),
      path('profile/', views.profile_view, name='profile'),
   ]

5. Add the url path to the src/django_management/urls.py path

   # Example to add to urlpatterns in src/django_management/urls.py
   path('accounts/', include('accounts.urls')),

6. Add the subapplication to src/django_management/settings.py

   INSTALLED_APPS = [
      ...
      # Other apps
      'accounts',
      'future_subapplication_names'
   ]

Branches

• Branches must be named as follows in order for a pull request with that branch to be accepted: branch-type/issue-##/short-description

• branch-type must be one of bugfix, feature, hotfix, chore, release, test, doc, or refactor

Pull Requests

• Ensure your branch follows the appropriate naming conventions (above)
• While only one review is required, aim for two reviews.
• Do not resolve conversations you did not create. All conversations should be resolved before merging
• If your change after opening the Pull Request greatly modified your code, you should request a re-review
• All tests and lints should pass before merging
• Only the developer who opened the Pull Request should merge the Pull Request
• Always use Squash and merge to keep the commit history clean
• Delete branch after merging to keep the branch tree clean

Linting

This project uses flake8 and black for linting and formatting Python files and djlint for HTML templates. To run linting locally:

black ./src # This automatically reformats
flake8 ./src
djlint src/ --lint

• If you want to reformat your HTML files, this will automatically re-format and indent them. Errors in linting that need to manually corrected may still exist after reformatting.

  djlint src/ --reformat

Running tests and coverage

To run coverage tests locally:

coverage run --source='src' src/manage.py test

Deployment

• This application is set up for deployment using AWS Elastic Beanstalk.
• Deployment is handled using Travis CI. Deployments are automatic on pushes to the main branch or the develop branch
• The develop branch deploys here.
• The main branch deploys here.