MVI-Clean-Architecture

This is a sample app & basic code that demonstrate how to build an Android application using the Uncle Bob's Clean Architecture approach.

The trick of the project is to demonstrate best practices, provide a set of guidelines, and present modern Android Application Architecture that is modular, scalable, maintainable and testable, suitable for bigger teams and long application lifecycle management.

Because it is an architectural project, UI has been kept simple. Sample data has been provided from JsonPlaceholder API You can directly clone the repo and run the app.

Flow

This app uses MVI (Model View Intent) architecture.

Modules

Modules are the collection of source files and build settings that allow you to divide your project into discrete units of functionality.

• App Module

  :app module is an com.android.application, which is needed to create the app bundle. It contains dependency graph and UI related classes. It presents data to screen and handle user interactions.

• Base Module

  :base module contains only framework related base classes that is used in other modules

• Common Module

  :common module contains code and resources which are shared between other modules

• Data Module

  :data module contains implementation of repository and local - remote repository interface adapt

• Domain Module

  :domain module contains use cases and repository interface adapt

• Local Module

  :local module contains local data source related classes

• Remote Module

  :remote module contains remote data source related classes

• Presentation Module

  :presentation module contains business logic

Each module has its own test.

Tech Stack

• Kotlin
• Jetpack
  • Android KTX
  • Lifecycle
  • Data Binding
  • View Binding
  • ViewModel
  • Navigation Component
  • Room
• Coroutines - Flow
  • State Flow
  • Shared Flow
  • Channels
• Dagger Hilt
• Retrofit
• OkHttp
• KotlinX
• KotlinX Serialization Converter
• LeakCanary
• Testing
  • MockK
  • Junit4
  • Truth
  • Turbine
  • Fragment Testing
  • Navigation Testing
  • Coroutine Test
  • Barista
  • Dagger Hilt Testing

Contributions

All contributions are welcome! Please fork this repository and contribute back using pull requests.

Contact

• Linkedin
• Medium

Don't forget to star ⭐ the repo it motivates me to share more open source

License

MIT License

Copyright (c) 2021 Yusuf Ceylan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.