Android Simple Boilerplate

Provides a convenient basic start-off point for all your new Android projects.

Tries to employ the best tools and practices.
Does not contain (almost) any architectural patterns or solutions.

It draws inspiration from Chris Banes's Tivi but adds many customizations and optimizations.

Note: this project is Kotlin-based and is not designed to be Java-friendly.

Things included

Gradle setup with all its little quirks
buildSrc module with Gradle Kotlin DSL. It provides autocomplete and other niceties in managing Gradle dependencies
CI/CD with automated Unit/Robolectric tests, Firebase Test Lab integration, and Play Store publishing
Static code analysis
Crash reporting via Crashlytics
Firebase Performance Monitoring
Simple Dagger2 setup

Usage

For detailed instructions on how to configure this template project for you, see Wiki.

Tools that are used

Build process

CircleCI for continuous integration
Gradle Play Publisher for continuous delivery
Spotless + ktlint to enforce code formatting and styling
Gradle Versions Plugin to automatically check for new versions of your dependencies
Dexcount Gradle Plugin to keep track of app's method count

Integrations

Crashlytics for crash reporting
Firebase Performance Monitoring to gain insights into your app's performance

Testing

Espresso for UI tests
Robolectric to run all tests (including Espresso-based) on a local JVM

Libraries

LeakCanary to detect memory leaks
Dagger2 for dependency injection
RxJava + RxKotlin + RxAndroid + Coroutines for asynchronous programming
rxlint for Lint-checking RxJava code
Timber for logging
ThreeTenABP + ThreeTenBP to use Java 8 Time and Data API

Included but not used

Android KTX for more pleasant usage of Android APIs with Kotlin extension functions
Material Design to use components from Material Design guidance
Mockito to mock dependencies
Mockito-Kotlin to provide more idiomatic usage of Mockito in Kotlin
Lifecycles from Android Jetpack to manage Activity and Fragment lifecycles

Contributing

All contributions in form of issues or pull requests are welcome.
You should create an issue first if you want to introduce a significant change.

License

Project License

MIT License

Copyright (c) 2018 Andrii Chubko

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.

Third-party Licenses

Third-party licenses are included in LICENSE-3RD-PARTY.

License

qwertyfinger/android-simple-boilerplate

ErrorLooks like something went wrong!

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages