jkzilla/android-starter

[Android Architecture] Android starter based on MVP/Dagger2/RxJava2/Robolectric/Espresso/Mockito. It provides a generator to fast create a Android template project.

AndroidMvpStarter

An MVP Boilerplate to save me having to create the same project over from scratch every time! :)

This project uses:

• RxJava2 and RxAndroid
• Retrofit / OkHttp
• Gson
• Dagger 2
• Butterknife
• Google Play Services
• Timber
• Glide 3
• Stetho
• Espresso for UI tests
• Robolectric for framework specific unit tests
• Mockito
• Checkstyle, PMD and Findbugs for code analysis

Create new project using yeoman generator-android-mvp-starter

npm install -g yo
npm install -g generator-android-mvp-starter
mkdir NewApp && cd $_
yo android-mvp-starter

Building

To build, install and run a debug version, run this from the root of the project:

./gradlew app:assembleDebug

Testing

To run unit tests on your machine:

./gradlew test

To run instrumentation tests on connected devices:

./gradlew connectedAndroidTest

Code Analysis tools

The following code analysis tools are set up on this project:

• PMD

./gradlew pmd

• Findbugs

./gradlew findbugs

• Checkstyle

./gradlew checkstyle

The check task

To ensure that your code is valid and stable use check:

./gradlew check

Jacoco Reports

Generate Jacoco coverage reports for the Debug build. Only unit tests.

app:testDebugUnitTestCoverage

Generate Jacoco coverage reports for the Release build. Only unit tests.

app:testReleaseUnitTestCoverage

Generate Jacoco coverage reports for the Debug build. Both unit and espresso tests.

app:unitAndEspressoDebugTestCoverage

Generate Jacoco coverage reports for the Release build. Both unit and espresso tests.

app:unitAndEspressoReleaseTestCoverage

Created & Maintained By

Ravindra Kumar (@ravidsrk)

If you found this repo helpful or you learned something from the source code and want to thank me, consider buying me a cup of ☕

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

MIT License

Copyright (c) 2017 Ravindra Kumar

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.