Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voghdev/dagger2-clean-mvp-example
Sample project with a basic approach to CLEAN architecture on Android
https://github.com/voghdev/dagger2-clean-mvp-example
android architecture clean-architecture mvp patterns testing
Last synced: 8 days ago
JSON representation
Sample project with a basic approach to CLEAN architecture on Android
- Host: GitHub
- URL: https://github.com/voghdev/dagger2-clean-mvp-example
- Owner: voghDev
- License: apache-2.0
- Created: 2015-06-03T18:16:30.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-05-04T10:55:36.000Z (over 4 years ago)
- Last Synced: 2023-02-27T20:18:00.447Z (over 1 year ago)
- Topics: android, architecture, clean-architecture, mvp, patterns, testing
- Language: Java
- Size: 2.1 MB
- Stars: 41
- Watchers: 4
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Dagger2-CLEAN-MVP Example
[](https://travis-ci.org/voghDev/dagger2-clean-mvp-example)
Sample project with the first steps of my approach to Android CLEAN architecture, based on elegant solutions from respected developers.
Features a List of users, obtained from randomuser API.
Some of the aspects covered on this project are:
* Dependency Injection using [Dagger2][6].
* Elegant ~~ListView~~ **RecyclerView** implementation using [Renderers][15].
* View binding using Jake Wharton's [ButterKnife 6.x][11] (current is 8.x).
* Image loading using [picasso][12], round transformations using **PorterDuff**.
* Model-View-Presenter + Interactor + DataSource layers, with different **DataSource**s:
* a REST Api using [retrofit][13]
* a local **JSON file**
* a class generating **mock** instances
* Code-style rules using [checkstyle][16]. [This blogpost][17] indicates how checkstyle has been imported
* Android Unit testing using JUnit 4 and [Mockito][18].
* UI Testing using [Espresso][19]
* Simple **MVP** implementation without interfaces because [Interfaces for presenters in MVP are a waste of time](https://gist.github.com/pedrovgs/61a8301a9952d195081edc989aa1fd41).
* [Travis CI][22] integration including instrumentation tests ran on an AVD. see [.travis.yml script][23]
![Screenshot][firstScreenshot]
This project has taken the following **talks**, **articles**, and **repos** as inspiration (it wouldn't have been possible without them)
* [Jorge Barroso - Forgetting Android][3]
* [Pedro Vicente Gómez Sánchez - EffectiveAndroidUI][2]
* [Dependency Injection on Android - Pedro Gómez][4]
* [Dagger2 Example by David Lázaro][5]
* [Google's Dagger Example][6]
* [Antonio Leiva's MVP Example][7] and [Blog article][8]
* [protohipster - Jorge Barroso][21]
* [UpcomingMoviesMVP - Jose Luis Martín][14]
* [KataSuperHeroesAndroid - Karumi][20]
TODOs
-----
- [X] A better Thread management to do heavier operations outside the UI Thread
- [X] RecyclerViews, Renderers2.0
- [X] Unit tests
- [X] UI tests
- [X] Refactor to add Repository layer
- [X] Refactor Presenter layer to make it testable with JUnit
- [X] Add retrofit2-based API layer ~keeping the retrofit1 one~
- [X] Redesign UI to a more attractive one
Developed By
------------
* Olmo Gallegos Hernández - [@voghDev][9] - [mobiledevstories.com][10]
* Sylvia Domenech
# License
Copyright 2016 Olmo Gallegos Hernández
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.
Imagery
-------
All icons & art were obtained from [flaticon.com][24], an excellent resource for downloading icons under attribution. If you don't know it, I recommend you to have a look, and don't forget to credit the authors!
[firstScreenshot]: ./screenshots/sample1.gif
[1]: https://github.com/pedrovgs/
[2]: https://github.com/pedrovgs/EffectiveAndroidUI
[3]: https://www.youtube.com/watch?v=ROdIvrLL1ao
[4]: https://www.youtube.com/watch?v=N6yqe88ysNw
[5]: https://github.com/dlazaro66/Dagger2-example
[6]: https://github.com/google/dagger
[7]: https://github.com/antoniolg/androidmvp
[8]: http://www.limecreativelabs.com/mvp-android/
[9]: http://twitter.com/voghDev
[10]: http://www.mobiledevstories.com
[11]: https://github.com/JakeWharton/butterknife
[12]: https://github.com/square/picasso
[13]: https://github.com/square/retrofit
[14]: https://github.com/jlmd/UpcomingMoviesMVP
[15]: https://github.com/pedrovgs/Renderers
[16]: http://checkstyle.sourceforge.net/
[17]: https://mobiledevstories.wordpress.com/2016/06/17/android-configuring-checkstyle-for-your-android-project/
[18]: http://mockito.org/
[19]: https://google.github.io/android-testing-support-library/docs/espresso/
[20]: https://github.com/Karumi/KataSuperHeroesAndroid
[21]: https://github.com/flipper83/protohipster
[22]: http://travis-ci.org
[23]: https://github.com/voghDev/dagger2-clean-mvp-example/blob/master/.travis.yml
[24]: http://www.flaticon.com