README.md

STATUS: Refactoring! Please check the TODOs below in the project status section.

Android - Clean Architecture - Kotlin

The purpose of this repo is to follow up Clean Architecture principles by bringing them to Android. It is worth saying that the idea is to take advantage of the Kotlin Programming Language features plus also pull in lessons learned and ideas from other interesting approaches like Functional Programming.

Project Status

• Last Update: 2024.08
  • WIP: Migrate to Kotlin 2.0.
  • WIP: Migrate to Jetpack Compose.
  • TODO: Bug Fixes.
  • TODO: Reorganize and cleanup tests.
  • TODO: Reorganize dependencies and build system.

Blog post with implementation details explanation:

Architecting Android… Reloaded

Android - Clean Architecture - Java:

There is another Android Clean Architecture repository written in Java: https://github.com/android10/Android-CleanArchitecture with really nice discussions: https://github.com/android10/Android-CleanArchitecture/issues. Article, lessons learned and some more material coming up. Check the following known bugs and TODO list.

Other material worth reading:

Architecting Android…The clean way?

Architecting Android…The evolution

Tasting Dagger 2 on Android

Clean Architecture…Dynamic Parameters in Use Cases

----------------------------------------------------------------------------------------------

Sample app

----------------------------------------------------------------------------------------------

Clean Architecture

----------------------------------------------------------------------------------------------

Android 3 Layers Architecture

----------------------------------------------------------------------------------------------

UI Layer: MVVM

----------------------------------------------------------------------------------------------

Data Layer: Repository

----------------------------------------------------------------------------------------------

Local Development

Here are some useful Gradle/adb commands for executing this example:

• ./gradlew runApp - Builds and install the debug apk on the current connected device.
• ./gradlew compileApp - Builds the debug apk.
• ./gradlew runUnitTests - Execute unit tests (both unit and integration).
• ./gradlew runAcceptanceTests - Execute acceptance and instrumentation tests in the connected device.
• ./gradlew runTestCoverage - Reports code coverage on tests within the Android codebase.
• ./gradlew runStaticCodeAnalysis - Run static analysis on the Android codebase.

Discussions

Refer to the issues section: https://github.com/android10/Android-CleanArchitecture-Kotlin/issues

License

Copyright 2024 Fernando Cejas

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.