Giter Club home page Giter Club logo

finddriver's Introduction

Welcome to FindDriver

It's an app built using the MVVM, Repository pattern and Clean Architecture with JetPack Compose for UI Presentation,that show user registration.


Index


Key Features

  1. Separation of Concerns: The app is built using Uncle Bob's clean architecture (see architecture below)
  2. Reusable feature modules: Modern feature module design pattern is used so that in future the same module is used other apps also.
  3. Scalable navigation architecture: Feature modules are independent of app-level implementation detail. Navigation architecture can be changed at anhy time without effecting the features

Architecture

The app is built with scalability in mind. to maintain the separation of concerns, Clean Architecture by Robert C. Martin, is used. The diagram below shows how the clean architecture is mapped to this android application.

Flow of control:

The design pattern for this app is a Unidirectional data flow (UDF) where state flows down and events flow up. Flow of control is one directional only. Any inner layer doesn't know about any layer outside of it. If an inner layer needs to communicate to an outer layer, it is done via Dependency Inversion. To maintain this separation over the course of time, separate android/kotlin modules can be used for each layer for bigger features.

Modules

The app has mainly following modules

core

  • Domain - module provides a bridge between data layer and UI layer.Domain layer is Platform independent. It gets the data from remote or local datasource to UI layer.
  • Network - module is responsible for getting data from remote datasource and provide it to Domain layer.

framework

It will contain the general methods and classes that will need in all our feature modules and app module like theming,components,utility functions.

Feature Modules

  • Sign - contains the login and registration of rider and user. Feature modules are unaware of each other. Hence, they can be used independently in any app

Navigation

The feature modules are unaware of the app-level navigation. App controls the navigation between each module. Currently, it uses Jetpack Navigation. But this can be changed at any time without affecting any feature module.

This is implemented as per Google's recommendation for multi-module navigation. This allows us to have an independent navigation architecture in each feature module.


Screenshots


Libraries

  • UI Design - Compose UI
  • AndroidX - Fragments, ViewModel
  • KotlinX - Coroutines, Flow, SharedFlow, Serialization
  • Hilt - Dependency Injection
  • Navigation Component - User navigation
  • Retrofit - API Calls
  • DataStore - Cache token using Preference Datastore and users data using Proto DataStore

Future Enhancements

These are the enhancements that are important but were left because of time constraints:

Features

  1. Testing Strategy (testing using JUnit4,Mockk,Google Truth,Turbine libraries).
  2. Google place api for pickup and dropoff location. Also get user location using Camera Center of google map
  3. Google map implementation.
  4. Payment api implementation.
  5. send driver location to server using Workmanager
  6. Push Notification
  7. Implement Room database behind the LocalDataSource for real caching.
  8. Implement a cache strategy to refresh the cache data at regular intervals

finddriver's People

Contributors

mubarakaali avatar mubarakvyro avatar

Watchers

 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.