Code Monkey home page Code Monkey logo

saumya-28 / resqfood Goto Github PK

View Code? Open in Web Editor NEW

This project forked from sourabhkumar47/resqfood

0.0 0.0 0.0 5.92 MB

ResQFood is a platform dedicated to the noble cause of reducing food wastage by facilitating the redistribution of surplus food during late-night hours before restaurant closures. Our mission is to ensure that excess inventory finds a purposeful destination rather than ending up in landfills, contributing to a more sustainable and compassionate foo

License: MIT License

Kotlin 100.00%

resqfood's Introduction

ResQFood: Bridging the Gap Between Leftovers and Hungry Stomachs

Feel free to star โญ the repository if you find it valuable.

banner

About

ResQFood's vision is to build a world where delicious food doesn't end up in the trash. By bringing together restaurants and individuals, we create a win-win scenario for everyone involved.

This platform is dedicated to the noble cause of reducing food wastage by facilitating the redistribution of surplus food during late-night hours before restaurant closures. Our mission is to ensure that excess inventory finds a purposeful destination rather than ending up in landfills, contributing to a more sustainable and compassionate food ecosystem.

It is a mobile app designed to connect restaurants with individuals looking for a delicious and affordable meal while tackling food waste. It empowers restaurants to utilize leftover food instead of discarding it and provides individuals with access to great deals on quality food.

๐Ÿ’ป Tech Stack:

Kotlin logo

Jetpack Compose logo

App Features: TODO

Design Idea:

Welcome & Onboarding Screens

  • Welcome Screen: Show the app's name, a tagline like "Delicious Meals, Less Waste," and a "Get Started" button.
  • Onboarding Screens:
  • A series of 3-4 screens explaining the app's purpose and key features with illustrations.
    • Screen 1: "Save Money on Quality Meals"
    • Screen 2: "Help Reduce Food Waste"
    • Screen 3: "Support Local Restaurants"
    • Screen 4: "Join a Sustainable Community"
  • Login/Signup Screen: Options to sign up with email, Google, or Facebook. Include a "Continue as Guest" option

Home Screen (For Individuals)

  • Top Navigation Bar: App logo, search bar, profile icon.
  • Search & Filter Options: Filters for location, cuisine type, price, and pickup window.
  • Featured Listings: Carousel of highlighted leftovers with images, names, and prices.
  • Nearby Restaurants: List of nearby restaurants with available leftovers.
  • Categories: Tabs for Appetizers, Main Courses, Desserts, etc.
  • Map View: Toggle option to switch between list view and a map view showing restaurant locations.

Restaurant Profile Screen

  • Profile Information: Restaurant name, contact info, cuisine type, operating hours.
  • About Us: Short description of the restaurant.
  • Food Listings: Grid or list of available leftovers with images, descriptions, quantities, and prices.
  • Reviews & Ratings: User reviews and average rating.

Adding Leftovers (For Restaurants)

  • Add Item Screen: Form to add leftover items.
  • Item Name: Text field.
  • Description: Text area.
  • Category: Dropdown menu (Appetizers, Main Courses, Desserts, etc.).
  • Quantity: Number input.
  • Estimated Value: Number input.
  • Price: Number input (option for free).
  • Pickup Window: Time picker.
  • Add Image: Option to upload a photo.
  • Submit Button: Button to save the listing.

Ordering & Pickup (For Individuals)

  • Item Details Screen: Detailed view of a leftover item.
  • Image: Large image of the item.
  • Description: Detailed description.
  • Pickup Time: Display pickup window.
  • Price: Display price.
  • Claim Button: Button to claim the item.
  • Order Confirmation Screen: Confirmation details of the order with directions to the restaurant.
  • Payment Integration: Integrated payment options for items with a fee.

Notifications

  • Notification Center: List of notifications.
  • Order Confirmations: Notifications for confirmed orders.
  • Ready for Pickup: Alerts when an item is ready for pickup.
  • New Listings: Notifications about new leftovers from favourite restaurants.

Tracking & Analytics (For Restaurants)

  • Dashboard Screen: Visual stats and graphs.
  • Food Saved: Amount of food saved from waste.
  • Total Orders: Number of orders fulfilled.
  • User Feedback: Summary of user reviews and ratings.

Communication

  • Messaging Screen: In-app messaging interface.
  • Chat List: List of ongoing conversations.
  • Chat Window: Individual chat with text input and send button.
  • Notifications for Messages: Alerts for new messages.

Profile & Settings

  • User Profile Screen: User information, order history, saved restaurants.
  • Restaurant Profile Settings: Edit restaurant details, manage listings and view analytics.
  • Security & Privacy Settings: Options to manage account security, notifications, and privacy settings.

Community Building

  • Community Feed: Social feed for sharing tips on reducing food waste, sustainability articles, and success stories.
  • Events & Campaigns: Information on community events related to food waste and sustainability.

Why ResQFood?

Reduces Food Waste: Food waste is a major environmental and economic problem. ResQFood helps restaurants reduce their waste and minimize their environmental footprint. Saves Money: Restaurants can recover some of their costs by selling leftover food at reduced prices. Individuals can enjoy delicious meals at a fraction of the original cost. Supports Local Restaurants: ResQFood strengthens local communities by supporting small businesses and helping them operate more sustainably. Promotes Food Security: By making affordable food more accessible, ResQFood contributes to food security, especially for individuals who may be facing food insecurity.

Contributing

We welcome contributions from the community to help improve and expand ResQFood. Whether you're a developer, designer, or passionate about our cause, we'd love to have you on board! Check out our learn to get started.

Setup and Installation

To contribute to the ResQFood repository, follow these steps:

  1. Fork the Repository: Click on the "Fork" button on the repository's GitHub page to create a copy of the repository in your GitHub account.

  2. Clone the repository: Clone the forked repository to your local machine using the following command in your terminal.

    git clone https://github.com/sourabhkumar47/ResQFood
  3. Change the repository to your working repository:

    cd ResQFood

  4. Add a remote upstream:

    git remote add upstream https://github.com/sourabhkumar47/ResQFood
  5. Create a new branch: Create a new branch for your changes. Run the following command in your terminal.

    git checkout -b <your-branch-name>
  6. Make the desired changes: Make the desired changes to the source code.

  7. Add your changes: Add your changes to the staging area. Run the following command in your terminal.

    git add <File1 changed> <File2 changed> ...
  8. Commit your changes: Commit your changes with a meaningful commit message. Run the following command in your terminal.

    git commit -m "<your-commit-message>"
  9. Push your changes: Push your changes to your forked repository. Run the following command in your terminal

    git push origin <your-branch-name>
  10. Create a Pull Request: Go to the GitHub page of your forked repository. You should see a prompt to create a pull request (PR). Click on it, compare the changes, and create the PR.

  11. Wait for your PR Req: Wait for your PR request till it gets approved. All details about your pr will be shared by admins soon.

Support

If you have any questions, feedback, or need assistance, feel free to reach out to us at discussion panel We're here to help!

License

ResQFood is licensed under the MIT License.


resqfood's People

Contributors

sourabhkumar47 avatar hemangmishra1234 avatar regxl2 avatar lucky-chelani avatar saumya-28 avatar varun-sethi-dev avatar me-shweta avatar asymtode712 avatar suhanipaliwal avatar tonystark-47 avatar rajkumarbhakta avatar artigaund avatar anglerfishlyy avatar okellosam21 avatar debayan-ghosh2005 avatar hemu21 avatar pradnyagaitonde avatar sibam-paul avatar thevijayshankersharma avatar kanishk-2 avatar officeneerajsaini 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.