Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/happysingh23828/Android-Clean-Architecture
This is a sample movie list Android application built to demonstrate use of Clean Architecture tools. Dedicated to all Android Developers - (Kotlin, MVVM, Clean Architecture, Rx-Java, Dagger, OkHttp, Unit Testing, SOLID principles, Code Coverage)
https://github.com/happysingh23828/Android-Clean-Architecture
android android-app android-architecture android-sdk android-studio cache clean-architecture cleanarchitecture domain mvvm room solid-principles
Last synced: 3 months ago
JSON representation
This is a sample movie list Android application built to demonstrate use of Clean Architecture tools. Dedicated to all Android Developers - (Kotlin, MVVM, Clean Architecture, Rx-Java, Dagger, OkHttp, Unit Testing, SOLID principles, Code Coverage)
- Host: GitHub
- URL: https://github.com/happysingh23828/Android-Clean-Architecture
- Owner: happysingh23828
- License: mit
- Created: 2020-03-31T08:39:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-10T08:58:23.000Z (about 3 years ago)
- Last Synced: 2024-07-16T06:37:43.718Z (4 months ago)
- Topics: android, android-app, android-architecture, android-sdk, android-studio, cache, clean-architecture, cleanarchitecture, domain, mvvm, room, solid-principles
- Language: Kotlin
- Homepage: http://happysingh.dev/
- Size: 5.91 MB
- Stars: 295
- Watchers: 5
- Forks: 51
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-android-kotlin-apps - Android-Clean-Architecture - (Kotlin, MVVM, Clean Architecture, Rx-Java, Dagger, OkHttp, Unit Testing, SOLID principles, Code Coverage)</br></br> <b>Tech Stack</b> : Dagger, Unit Testing for modules, Mockito, RxJava, Retrofit, Room, CI-CD, SOLID, Code Coverage, Jacoco, Detekt, ktlint, Stetho, LiveData, ViewModel </br></br> <i> Last commit: 2 years ago</i> | 🌟 295 </br> 🍴 51 </br> 👁️ 5 | (:art: Pattern / MVVM)
README
# Android Clean Architecture
[](https://app.codacy.com/manual/happysingh23828/Android-Clean-Architecture?utm_source=github.com&utm_medium=referral&utm_content=happysingh23828/Android-Clean-Architecture&utm_campaign=Badge_Grade_Settings)
[](https://www.android.com)
[](LICENSE)
This is a sample movie list Android application 📱 built to demonstrate use of *Clean Architecture* tools. Dedicated to all Android Developers with ❤️.
***You can Install and test latest app from below 👇***
[](https://github.com/happysingh23828/Android-Clean-Architecture/raw/master/files/clean-arc.apk)
## - How to build on your environment
Add your API key in **local.properties** file.
```xml
tmdb_api_key = YOUR_API_KEY
```
If you don't have tmdb api key you can create new key from [here](https://developers.themoviedb.org/3/getting-started/introduction).
## - About
It simply loads **Popular Movies** list from [TMDB-API](https://www.themoviedb.org/) and stores it in persistence storage (i.e. Room Database). Movies list will be always loaded from local database. Remote data (from API) and Local data is always synchronized.
It has feature of bookmark movie which will be stored locally.
- Modular approch followed
- It is heavily implemented by following standard clean architecture principle.
- Offline capability.
- It has cache expiration feature [5 minutes].
- Unit testing written for all layers.
- Multi Module Code Coverage reports using Jacoco.
- static code analyses added by using detekt, ktlint.
- Android CI github action integration.
- [S.O.L.I.D](https://en.wikipedia.org/wiki/SOLID) priciple followed for more understandable, flexible and maintainable.
### - Disclaimer
Note: The use of clean architecture may seem over-complicated for this sample project. However, this allows us to keep the amount of boilerplate code to a minimum and also demonstrate the approach in a simpler form.
Clean Architecture will not be appropriate for every project, so it is down to you to decide whether or not it fits your needs 🙂
## - Built With 🛠
- [Kotlin](https://kotlinlang.org/) - First class and official programming language for Android development.
- [Rx-Java](https://github.com/ReactiveX/RxJava) - For composing asynchronous and event-based programs by using observable sequences.
- [Android Architecture Components](https://developer.android.com/topic/libraries/architecture) - Collection of libraries that help you design robust, testable, and maintainable apps.
- [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) - Data objects that notify views when the underlying database changes.
- [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Stores UI-related data that isn't destroyed on UI changes.
- [Room](https://developer.android.com/topic/libraries/architecture/room) - SQLite object mapping library.
- [Dagger 2](https://dagger.dev/) - Dependency Injection Framework
- [Retrofit](https://square.github.io/retrofit/) - A type-safe HTTP client for Android and Java.
- [OkHttp](http://square.github.io/okhttp/) - HTTP client that's efficient by default: HTTP/2 support allows all requests to the same host to share a socket
- [Glide](https://github.com/bumptech/glide) - image loading framework for Android
- [Gson](https://github.com/google/gson) - used to convert Java Objects into their JSON representation and vice versa.
- [Mockito](http://site.mockito.org/) - Most popular mocking framework for Java/kotlin.
- [Robolectric](http://robolectric.org/) - allows you to write unit tests and run them on a desktop JVM while still using Android API.
- [Stetho](https://github.com/facebook/stetho) - Stetho is a debug bridge for Android applications, enabling the powerful Chrome Developer Tools and much more.
- [Detekt](https://detekt.github.io/detekt/) - Detekt is a static analyze tool for the Kotlin language. It's open source.
- [Ktlint](https://github.com/pinterest/ktlint) -Ktlint is a static code analysis tool maintain by Pinterest. Linter and formatter for Kotlin code.
## - Clean Architecture
- photo by: raywenderlich
### What is clean architecture?
Architecture means the overall design of the project. It's the organization of the code into classes or files or components or modules. And it's how all these groups of code relate to each other. The architecture defines where the application performs its core functionality and how that functionality interacts with things like the database and the user interface.
### Why the cleaner approach?
1. Separation of code in different layers with assigned responsibilities making it easier for further modification.
2. High level of abstraction
3. Loose coupling between the code
4. Testing of code is painless
> Clean code always looks like it was written by someone who cares. - by Michael Feathers”
### Layers
- **Domain** - Would execute business logic which is independent of any layer and is just a pure kotlin/java package with no android specific dependency.
- **Data** - Would dispense the required data for the application to the domain layer by implementing interface exposed by the domain.
- **Presentation / framework** - Would include both domain and data layer and is android specific which executes the UI logic.
## - Modules of App
### App
It uses the all the components and class releated to Android Framework. It gets the data from presentation layer and shows on UI.
### BuildSrc
This module helps to list and manage all the dependencies of the app at one place. It has list of dependencies and versions of that dependencies.
### Data
The Data layer is our access point to external data layers and is used to fetch data from multiple sources (the cache and remote in our case).
### Cache
The Cache layer handles all communication with the local database which is used to cache data.
### Domain
The domain layer responsibility is to simply contain the UseCase instance used to retrieve data from the Data layer and pass it onto the Presentation layer.
### Presentation
This layer's responsibility is to handle the presentation of the User Interface, but at the same time knows nothing about the user interface itself. This layer has no dependence on the Android Framework, it is a pure Kotlin module. Each ViewModel class that is created implements the ViewModel class found within the Architecture components library. This ViewModel can then be used by the UI layer to communicate with UseCases and retrieve data.
### Remote
The Remote layer handles all communications with remote sources, in our case it makes a simple API call using a Retrofit interface.
## - Code Coverage Reports
This projects uses [jacoco plugin](https://www.jacoco.org/jacoco/) for generate code coverage reports. currently each modules generates seprate code reports.
#### Java/Kotlin Modules
Use `./gradlew jacocoTestReport`
Reports location for each module-
`-/data/build/reports/jacoco/test/html/index.html`
`-/domain/build/reports/jacoco/test/html/index.html`
`-/remote/build/reports/jacoco/test/html/index.html`
#### Android Modules
Use `./gradlew jacocoTestReportDebug`
Reports location for each module-
`-/app/build/reports/jacoco/debug/index.html`
`-/cache/build/reports/jacoco/debug/index.html`
`-/presentattion/build/reports/jacoco/debug/index.html`
## - Code Quality Checks
This projects uses detekt, ktlint static code analyser and auto formatter in CI/CD pipeline to maintain code quality. they also genrated reports.
#### Run detekt locally
Use `./gradlew detekt`
Reports location for each module-
`-/cache/build/reports/detekt/report.html`
`-/domain/build/reports/detekt/report.html`
`-/remote/build/reports/detekt/report.html`
#### Run ktlint locally
Use `./gradlew ktlint`
Reports location for each module-
`-/app/build/reports/ktlint/ktlint-checkstyle-report.xml`
`-/cache/build/reports/ktlint/ktlint-checkstyle-report.xml`
`-/presentattion/build/reports/ktlint/ktlint-checkstyle-report.xml`
#### Run ktlint formatter locally
Use `./gradlew ktlintFormat`
## - Current App's Architecture
This app uses [***MVVM (Model View View-Model)***](https://developer.android.com/jetpack/docs/guide#recommended-app-arch) architecture.
## - Future Plans
1. Add another features, Showing the crew and cast list for a movie.
2. Instrumentation test cases to be added.
3. Merge all code covergae reports at single place.
4. MvRx implementaion on the UI layer.
5. MVI implementation on the UI layer.
6. Reach code coverage atleast 80%.
7. Dark Mode theme etc.
## - Thanks
A special thanks to the authors involved with this repository, they were a great resource during our learning!
- https://github.com/bufferapp/android-clean-architecture-mvi-boilerplate
## If this project helps you in anyway, show your love :heart: by putting a :star: on this project :v:
## - Contributing
Please fork this repository and contribute back using
[pull requests](https://github.com/happysingh23828/Android-Clean-Architecture/pulls).
Any contributions, large or small, major features, bug fixes, are welcomed and appreciated
but will be thoroughly reviewed .
### - Contact - Let's become friend
- [Blog](http://happysingh.dev/)
- [Youtube](https://www.youtube.com/channel/UCILhpbLSFkGzsiCYAeR30DA)
- [Github](https://github.com/happysingh23828)
- [Linkedin](https://www.linkedin.com/in/happpysingh23828/)
## - License
```
MIT License
Copyright (c) 2020 Happy Singh
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.```