https://github.com/hitherejoe/Android-Boilerplate
Android Boilerplate project using RxJava, Dagger 2, Espresso, Mockito + more!
https://github.com/hitherejoe/Android-Boilerplate
Last synced: 5 months ago
JSON representation
Android Boilerplate project using RxJava, Dagger 2, Espresso, Mockito + more!
- Host: GitHub
- URL: https://github.com/hitherejoe/Android-Boilerplate
- Owner: hitherejoe
- License: other
- Created: 2015-04-03T10:04:38.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-10-24T03:51:07.000Z (over 4 years ago)
- Last Synced: 2024-11-11T22:52:00.483Z (6 months ago)
- Language: Java
- Homepage:
- Size: 511 KB
- Stars: 1,865
- Watchers: 85
- Forks: 1,173
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: License.md
Awesome Lists containing this project
README
Android Boilerplate [](https://travis-ci.org/hitherejoe/Android-Boilerplate)
===================
A simple boilerplate application which demonstrates the downloading, persisting and syncing of data - displayed with a common layout used amongst applications.
The project is setup using:
- Functional tests with [Espresso](http://google.github.io/android-testing-support-library/docs/espresso)
- Unit tests with [Mockito](http://mockito.org/) and [Robolectric](http://robolectric.org/)
- [RxJava](https://github.com/ReactiveX/RxJava) and [RxAndroid](https://github.com/ReactiveX/RxAndroid)
- [Retrofit](http://square.github.io/retrofit/) and [OkHttp](https://github.com/square/okhttp)
- [Dagger 2](http://google.github.io/dagger/)
- [Butterknife](https://github.com/JakeWharton/butterknife)
- [Timber] (https://github.com/JakeWharton/timber)
- [Mockito](http://mockito.org/)
- [Glide](https://github.com/bumptech/glide)
Requirements
------------
- [Android SDK](http://developer.android.com/sdk/index.html).
- Android [6.0 (API 23) ](http://developer.android.com/tools/revisions/platforms.html#6.0).
- Android SDK Tools
- Android SDK Build tools 23.0.2
- Android Support Repository
- Android Support library
Building
--------
To build, install and run a debug version, run this from the root of the project:
./gradlew installRunDebug
Testing
--------
For Android Studio to use syntax highlighting for Automated tests and Unit tests you **must** switch the Build Variant to the desired mode.
To run **pmd**, **checkstyle** and **findbug** checks on your machine:
./gradlew check
To run **unit** tests on your machine:
./gradlew testDebugUnitTest
To run **automated** tests on connected devices:
./gradlew connectedDebugAndroidTest
Thanks
--------
Thanks to the following for contributions!
[ivacf] (https://github.com/ivacf)
[Jawnnypoo] (https://github.com/Jawnnypoo)
Attributions
------------
Thanks to the following for use of icons off of Noun Project:
[Iconoci](https://thenounproject.com/iconoci)