AhmedLSayed9/deliverzler
Delivery App for Restaurants built on Flutter using Domain-Driven Design (DDD) and Layered Architecture along with Riverpod Framework.
go to github for downloadDeliverzler
An open-source Delivery App for Restaurants built on Flutter using Domain-Driven Design (DDD) and
Layered Architecture along with Riverpod Framework, Firebase as backend, Navigation 2.0 (GoRouter),
Google Maps, Live Tracking, Local Notifications, FCM Notifications, Cloud Functions, Flutter Hooks,
Freezed, RxDart, FpDart and more.
Architecture Diagram:
Folder Structure:
- lib
- features
- feature1
- presentation
- screens
- components
- providers (all providers that have observable state used by the view)
- domain
- entities, aggregates and value objects
- services (encapsulate application and business logic, if any)
- infrastructure
- repos and facades
- dtos
- data_sources
- presentation
- feature1
- features
Note: This is my current approach and architecture. In addition, the repository includes other
branches that implement TDD and Clean Architecture approach if you’re interested:
- clean-arch branch: TDD and Clean Architecture approach using Riverpod 2.0 with code generation.
- clean-arch-no-code-gen branch: TDD and Clean Architecture approach using Riverpod 2.0 without code
generation.
ScreenShots
Instructions to run the project
- Create Firebase project and add it to your Flutter app (
Follow https://firebase.google.com/docs/flutter/setup instructions). - Add user manually at Firebase Auth to login with (This for testing as registration should be done
with another Admin app). - Add user data (id field from previous step - User UID) and some orders to show at your Firebase
Firestore similar to the following model architecture:
- Configure an API project with the Google Maps Platform and enable Maps SDK for Android/iOS (FREE)
to be able to open the map. Also, enable Directions/ Geolocation/Places APIs to enable other map
features as search and live tracking (You have to create a billing account to use these APIs). - Add your Google Map API Keys to the
configs.template
folder then rename the folder toconfigs
. - [Optional]: deploy functions within the project to Firebase Cloud Functions to receive FCM
notifications when new order is ready to be delivered. - Run the project using the command
flutter run --dart-define-from-file=configs/{flavor}.json
, or from VSCode using the predefined launch configurations.
Features
- Using Riverpod Framework with code generation (Most recommended) integrated with Flutter Hooks &
Freezed. - Simplified Layered architecture by relying on Riverpod to catch exceptions and auto convert it to
AsyncError instead of the traditional Result/Either pattern, which reduce lots of boilerplate
code. - Navigation 2.0 (declarative routing) with GoRouter using the code generation variant and
implementing nested navigation. - Functional Programming: FpDart(Option in particular) & RxDart.
- Firebase Firestore as the backend with Firebase Storage, FCM and Cloud Functions.
- Receive Local notification when arrive client’s location and the ability to call him or confirm
the order. - Receive FCM notification in (Foreground/Background/Terminated) when new order is ready to be
delivered. - Real-Time Changes from Firebase using Streams, Refreshing current stream capability.
- Optimized live location tracking using RxDart and updating delivery data on changes.
- Search places and update its information on map using Google Map Autocomplete & Place Details.
- Live tracking on map using Place Directions, Perform actions when arrive client’s location.
- Responsive UI, Platform-Aware Widgets, Multi-Themes, Internationalization & Localization (Using
Flutter without external packages). - Well documented features and Unit Tests.
Business Logic
- The app can be used by multiple delivery drivers in the restaurant. Also, you can make it work for
Multi-Vendor apps. - Only login screen for employee. You should authorize them in the backend by an admin app.
- Home screen will show stream of delivery orders that are ready to be delivered
upcoming
or is
deliveringonTheWay
. - Any employee can see order details and deliver
upcoming
orders. - Employee can deliver multiple orders.
- Only the employee that are delivering the order can confirm/cancel or show map of the order.
- If the client provided his location “in the client app” it’ll be loaded to the map, otherwise
employee can search for the location (new session token used for every search session to reduce
Google Maps bill). - When the order arrive to the destination by (200 meter) employee responsible for the order will
get local notification and will be able to confirm and call the client on the map. - If the delivery driver location changed with both (5seconds & 50meter change in distance), it’ll
update delivery geoPoint on the backend (for all his current delivering orders, so the clients
can listen to it) and will update map directions (for only the opened map, if any). - When new order is added to the backend (delivery order). All employees will get notification from
FCM (works with app in foreground, background or terminated). - Employee can add/edit his info at the profile screen.
Appreciation: I was inspired by @RandalSchwartz to adopt
and implement DDD Layered architecture with Riverpod Framework.
Also, ResoCoder’s DDD course (outdated) was a helpful start point to get some ideas about
implementing DDD Layered architecture in Flutter.
Give a ⭐️ if you like the project… Thanks!
![](/images/banner-woo.jpg)
related excellent projects recommendation download
AppFlowy
47859
AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust.
localsend
33797
An open-source cross-platform alternative to AirDrop
spotube
23772
🎧 Open source Spotify client that doesn't require Premium nor uses Electron! Available for both desktop & mobile!
revanced-manager
15035
💊 Application to use ReVanced on Android
gsy_github_app_flutter
14559
Flutter 超完整的开源项目,功能丰富,适合学习和日常使用。GSYGithubApp系列的优势:我们目前已经拥有Flutter、Weex、ReactNative、kotlin 四个版本。 功能齐全,项目框架内技术涉及面广,完成度高,持续维护,配套文章,适合全面学习,对比参考。跨平台的开源Github客户端App,更好的体验,更丰富的功能,旨在更好的日常管理和维护个人Github,提供更好更方便的驾车体验Σ( ̄。 ̄ノ)ノ。同款Weex版本 : https://github.com/CarGuo/GSYGithubAppWeex 、同款React Native版本 : https://github.com/CarGuo/GSYGithubApp 、原生 kotlin 版本 https://github.com/CarGuo/GSYGithubAppKotlin
dio
12249
A powerful HTTP client for Dart and Flutter, which supports global settings, Interceptors, FormData, aborting and canceling a request, files uploading and downloading, requests timeout, custom adapters, etc.
gopeed
11832
A modern download manager that supports all platforms. Built with Golang and Flutter.
bloc
11441
A predictable state management library that helps implement the BLoC design pattern
getx
9899
Open screens/snackbars/dialogs/bottomSheets without context, manage states and inject dependencies easily with Get.
flame
8846
A Flutter based game engine.
flutter_deer
7595
🦌 Flutter 练习项目(包括集成测试、可访问性测试)。内含完整UI设计图,更贴近真实项目的练习。Flutter practice project (including integration testing and accessibility testing). Contains complete UI design drawings for a more realistic practice project.
fish-redux
7343
An assembled flutter application framework.
fl_chart
6451
FL Chart is a highly customizable Flutter chart library that supports Line Chart, Bar Chart, Pie Chart, Scatter Chart, and Radar Chart.
pixez-flutter
6360
一个支持免代理直连及查看动图的第三方Pixiv flutter客户端
Flutter-Responsive-Admin-Panel-or-Dashboard
6355
Responsive Admin Panel or Dashboard using Flutter
aidea
6021
AIdea 是一款支持 GPT 以及国产大语言模型通义千问、文心一言等,支持 Stable Diffusion 文生图、图生图、 SDXL1.0、超分辨率、图片上色的全能型 APP。
riverpod
5828
A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.
pikapika
5463
美观易用且无广告的漫画和游戏客户端,同时支持MacOS,Windows,Android,iOS。
provider
5029
InheritedWidgets, but simple
getwidget
4416
Most popular and easy to use open source UI library with 1000+ Widgets to build flutter app.