Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ferPrieto/MVVM-Modularized
A clean architecture approach (modular) using MVVM, Dagger2, LiveData and RxAndroid
https://github.com/ferPrieto/MVVM-Modularized
android android-navigation dagger2 espresso fragments jetpack jetpack-android ktx-library livedata mockwebserver modular mvvm rxjava-android
Last synced: 3 months ago
JSON representation
A clean architecture approach (modular) using MVVM, Dagger2, LiveData and RxAndroid
- Host: GitHub
- URL: https://github.com/ferPrieto/MVVM-Modularized
- Owner: ferPrieto
- Created: 2019-10-20T22:57:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-01T23:42:41.000Z (over 4 years ago)
- Last Synced: 2024-08-01T19:52:55.116Z (6 months ago)
- Topics: android, android-navigation, dagger2, espresso, fragments, jetpack, jetpack-android, ktx-library, livedata, mockwebserver, modular, mvvm, rxjava-android
- Language: Kotlin
- Homepage:
- Size: 13.5 MB
- Stars: 13
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-list - ferPrieto/MVVM-Modularized - A clean architecture approach (modular) using MVVM, Dagger2, LiveData and RxAndroid (Kotlin)
README
# JokesApp
A demo app to show random jokes, with the aim of showing Clean Architecture and Clean code principles
in a MVVM setup, LiveData and Rxjava.
There's a cache memory used to save and retrieve a custom joke. In order to show a data cache implementation.
## About the project
For simplicity, I've chosen the ICNDb free API:
http://www.icndb.com/api/
### Initial approach
The initial Clean Architecture approach was developed by me in a Bitbucket repository using:
- MVVM
- RXJava
### Goals
In order to follow the latest Android standards, the project will include the next points (progressively):
- ~~Complete the VM unit tests~~ (DONE)
- ~~LiveData, instead of Rx (outputs)~~ (DONE)
- ~~UI Tests using Espresso and Robot pattern~~ (reference [Adam McNeilly]) (DONE)
- ~~MockWebServer for testing HTTP clients~~ (DONE)
- ~~Add Navigation Module~~ (DONE)
- ~~Improve UI elements~~ (DONE)
- ~~Add feature Detail~~ (DONE)
- Change modules for feature Module, in order to create two branches: `Feature-Modules` and `Data-Layer-Modules`
[Adam McNeilly]: https://github.com/AdamMc331
## Libraries Used
* [Rx][0] for reactive style programming (from VM to Data).
* [LiveData][1] for reactive style programming (from VM to UI).
* [Navigation][2] for in-app navigation.
* [Rx][3] for cache storage.
* [Dagger2][4] for dependency injection.
* [Retrofit][5] for REST api communication.
* [Timber][6] for logging.
* [Espresso][7] for UI tests.
* [Mockito-Kotlin][8] for mocking in tests.
* [MockWebServer][9] for Instrumentation tests.
* [AndroidX Test Library][10] for providing JUnit4 and functions as `launchActivity` in UI tests,
[0]: https://github.com/ReactiveX/RxAndroid
[1]: https://developer.android.com/topic/libraries/architecture/livedata
[2]: https://developer.android.com/topic/libraries/architecture/navigation/
[3]: https://github.com/ReactiveX/RxAndroid
[4]: https://github.com/google/dagger
[5]: https://github.com/square/retrofit
[6]: https://github.com/JakeWharton/timber
[7]: https://developer.android.com/training/testing/espresso/
[8]: https://github.com/nhaarman/mockito-kotlin
[9]: https://github.com/square/okhttp/tree/master/mockwebserver
[10]: https://github.com/android/android-test
## Demo
# License
Copyright 2019 Fernando Prieto Moyano
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.