Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 2.88 KB

README.md

File metadata and controls

39 lines (29 loc) · 2.88 KB

FoodLink

Idea

Our platform is designed to streamline food donation and distribution by connecting donors, agencies, and beneficiaries. It features user-friendly interfaces and robust functionality to ensure efficient management of donations while adhering to safety regulations and minimizing waste.

Features

  1. Account Registration: Donors and agencies can apply for accounts by providing basic information and entity certificates, which are reviewed and approved by the Food Bank.
  2. Food Posting: Donors submit information about donated food, including type, size, allergens, and safety compliance with the GSFD Bill, complete with photos and storage instructions.
  3. Donation Records: Donors can view and manage their donation history, with detailed records accessible through their personal interface.
  4. Guidelines Access: Donors can review GSFD Bill guidelines on a dedicated page to ensure compliance and encourage more donations.
  5. Beneficiary Account Creation: Agencies create and manage accounts for beneficiaries, setting quotas based on their needs to control food allocation.
  6. Request Records Management: Agencies monitor and access request records from beneficiaries under their management to track food distribution.
  7. Food Browsing: Beneficiaries and agencies browse available food donations with filters for type, region, and allergens to easily find and select items.
  8. Food Requesting: Beneficiaries and agencies request food by reviewing item details and submitting their requests, with confirmation messages for success or failure.
  9. Request History: Beneficiaries can check their own request records and view detailed information for each entry.
  10. Quota and Account Information: Beneficiaries can view their account details and remaining quota to manage their food requests within allocated limits.
  11. Account Application Review: The Food Bank reviews donor and agency account applications, deciding on approval or rejection based on the provided information.

Tech Stack

  • Frontend: React, JavaScript, DaisyUI
  • Backend: Firebase, Express, Postman

Starting the website

  • Frontend: npm install, npm run dev
  • Backend: npm install, node server.js

Branch convention and Dev Process

  1. Create a branch off main in the following format FE/<feature_name_or_fix> or BE/<feature_name_or_fix>
  2. Push code only to your branch and create a PR to main once ready
  3. Pull latest changes from main into branch before merging
  4. Merge if no conflicts