FridgeFriend is a Progressive Web App designed to connect individuals and communities with local fridges and pantries. The app provides a platform for users to locate, manage, and communicate with fridges and pantries in their area, as well as contribute to and engage with their local community. The Twilio API is integrated to facilitate real-time communication between users and pantry organizers.
The main features of FridgeFriend include:
- Interactive map for locating nearby fridges and pantries
- Real-time inventory management
- SMS notifications and alerts using the Twilio API
- Support Ticketing System
The project is divided into two main folders:
Client
: Contains the front-end React applicationServer
: Contains the back-end server application (technologies pending)
To get started with FridgeFriend, follow these steps:
-
Clone the repository to your local machine: https://github.com/The-Merge-Sorts/FridgeFriend.git
-
Change to the project directory:
cd FridgeFriend
-
Change to the
Client
directory:cd Client
-
Install the required dependencies:
npm install
-
Start the development server:
npm run dev
-
Open your browser and navigate to
http://localhost:3000
to access the app.
(Instructions for setting up the server will be added once the technologies are finalized)
- React.js
- Mapbox
- Auth0
- React Hook Form
- Tailwind CSS
(Technologies for the server will be added once they are finalized)