Awesome Open Source
Awesome Open Source

Kotlin Android Scaffolding Project

Just the basic structure of a kotlin android project. Still a WIP.

Architectural approach

The idea is to follow up Android clean architecture approach:

Build System approach

The build system is based on gradle, so for instance the project can be easily imported to both Android Studion and Intellij.

Testing approach

Tests are split up into Acceptance and Unit tests and essentially follow up the approach in this article I have written:


For now, the only way to use this WIP is by cloning the repo and manually setting it up. Go to the next section to see how to get started with the main files involved in the configuration.


Once the repository is cloned, follow this up:

  • You will have to rename the main packages manually.
  • Configuration and dependencies versions sit on the depedencies.gradle file.
  • There is a ci.gradle file for Travis and CI setup.


So far, these dependencies have been added:

  • Android Annotations
  • Android Compat
  • Dagger 2
  • RxJava 2
  • RxAndroid 2
  • Retrofit 2
  • JUnit 4
  • Robolectric 3
  • Mockito Kotlin
  • Kluent
  • Espresso
  • Leak Canary

Gradle tasks

Here are some useful Gradle/adb commands:

  • ./gradlew clean build - Build the entire app and execute unit and integration tests plus lint check.
  • ./gradlew installDebug - Install the debug apk on the current connected device.
  • ./gradlew deployDebug - Install and executes the debug apk on the current connected device.
  • ./gradlew runUnitTests - Execute unit and integration tests.
  • ./gradlew runAcceptanceTests - Execute acceptance tests.

Next steps

  • Automate all the things.
  • Fix issues.


Copyright 2017 Fernando Cejas

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
android (6,348
kotlin (3,659
testing (958
kotlin-android (335
android-application (282
android-app (244
android-development (222
rxjava2 (220
clean-architecture (209
retrofit2 (192
development (182
dagger2 (164
android-studio (140
android-sdk (73
developers (25