Code Monkey home page Code Monkey logo

fridgefriend's Introduction

FridgeFriend

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.

Description

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

File Structure

The project is divided into two main folders:

  • Client: Contains the front-end React application
  • Server: Contains the back-end server application (technologies pending)

Getting Started

To get started with FridgeFriend, follow these steps:

  1. Clone the repository to your local machine: https://github.com/The-Merge-Sorts/FridgeFriend.git

  2. Change to the project directory: cd FridgeFriend

Client

  1. Change to the Client directory: cd Client

  2. Install the required dependencies: npm install

  3. Start the development server: npm run dev

  4. Open your browser and navigate to http://localhost:3000 to access the app.

Server

(Instructions for setting up the server will be added once the technologies are finalized)

Technologies

Client

  • React.js
  • Mapbox
  • Auth0
  • React Hook Form
  • Tailwind CSS

Server

(Technologies for the server will be added once they are finalized)

fridgefriend's People

Contributors

wilsuriel03 avatar itcomesinwaves avatar eekbk avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.