themuleapp / mule-app

Tired of waiting in lines or taking a detour just to get a few items? Meet Mule. A new way to interact with deliveries. One tap and get whatever you want wherever you want.

Mule

Get delivered on the go.
Explore the docs »

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributions
  • Authors and Acknowledgements
• Dependencies
  • Dev Dependencies
• Contact
• Disclaimer

About The Project

Mule is an intelligent delivery system that enables people to act as delivery units in exchange for incentivized benefits. By offering a peer to peer delivery service, Mule ensures seamless communication across multiple entities.

Through our app we connect our users to “Mules” (Deliverers), who deliver a requested commodity from establishments close to them for an incentive which is chosen by both the mule and the user. Loaded with all the tools necessary to ensure a satisfying consumer experience, Mule has an active payment gateway, a chat portal to stay connected with the mules and a bidding system which ensures both parties can agree on a price.

We hope to create a world where delivery isn’t a hassle but an opportunity, an opportunity for the people to earn as well as leverage the resources they have to the best of their ability.

To better understand our concept, please watch our concept video:

Built With

• Flutter
• NodeJS
• MongoDB
• Google Cloud Platform
• Heroku
• Firebase

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Install an IDE. Our team members use Visual Studio Code or IntelliJ
• Install Flutter
• Set up your editor
• Test Drive

Installation

1. Clone the repository

git clone https://github.com/themuleapp/mule-app.git

2. Also clone the mule-backend repository if you will be working on the backend (Optional)

git clone https://github.com/themuleapp/mule-backend.git

3. Change the directory to the mule-app project repository and run the app

cd path/to/flutter/app
flutter run

You need to have a device connected, or a simulator open, for flutter run to work.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributions

Contributions are what help us grow and make us such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Please follow the GitHub Workflow while making contributions.

Authors and Acknowledgements

Our team of developers deserve all the appreciation in the world! Without them, we would not have reached this far.

Mrigank Doshy - Co-Founder and Developer
Ji Darwish - Lead Mobile Application Developer
Zohar Cochavi - Mobile Application Developer
Tarek Alabd - Mobile Application Developer

Dependencies

• Cupertino Icons
• MobX
• Get It
• Avatar Glow
• Email Validator
• Dio
• Font Awesome Flutter
• Flutter Secure Storage
• Google Maps Flutter
• Sliding Up Panel
• Geolocator
• Permission Handler
• Google Maps Web Service
• Flutter Typeahead
• Image Picker
• Fluster
• Flutter Cache Manager
• Flutter Polyline Points
• Flutter Progress Button
• Firebase Messaging
• LatLong
• Intl
• URL Launcher

Dev Dependencies

• Build Runner
• MobX Codegen

Contact

Feel free to Email us if you have any questions or feedback!
You can also visit our Website for more information.

Disclaimer

This software and app is not open source. Without a license, the default copyright laws apply, meaning that we retain all rights to our source code and no one may reproduce, distribute, or create derivative works from our work.