├── base ├── consumer-rules.pro ├── src │ └── main │ │ ├── AndroidManifest.xml │ │ ├── res │ │ └── values │ │ │ ├── strings.xml │ │ │ ├── colors.xml │ │ │ ├── dimens.xml │ │ │ └── styles.xml │ │ └── java │ │ └── template │ │ └── base │ │ ├── di │ │ └── ApplicationContext.kt │ │ └── extensions │ │ └── CoroutinesExtensions.kt ├── build.gradle.kts └── proguard-rules.pro ├── feature ├── consumer-rules.pro ├── src │ └── main │ │ ├── res │ │ ├── values │ │ │ └── strings.xml │ │ └── layout │ │ │ └── activity_feature.xml │ │ ├── java │ │ └── template │ │ │ └── feature │ │ │ ├── FeatureViewModel.kt │ │ │ ├── di │ │ │ ├── FeatureModule.kt │ │ │ └── FeatureComponent.kt │ │ │ └── FeatureActivity.kt │ │ └── AndroidManifest.xml ├── proguard-rules.pro └── build.gradle.kts ├── di ├── src │ └── main │ │ ├── AndroidManifest.xml │ │ └── java │ │ └── template │ │ └── di │ │ ├── AppComponentProvider.kt │ │ ├── ViewModelKey.kt │ │ ├── PerActivity.kt │ │ ├── module │ │ ├── ViewModelFactoryModule.kt │ │ └── NetworkModule.kt │ │ ├── AppComponentInjectHelper.kt │ │ ├── component │ │ └── ApplicationComponent.kt │ │ └── ViewModelFactory.kt └── build.gradle.kts ├── test-core ├── src │ └── main │ │ ├── AndroidManifest.xml │ │ └── java │ │ └── template │ │ └── test │ │ └── core │ │ ├── InstantTask.kt │ │ ├── CoroutinesExtension.kt │ │ ├── CoroutineTest.kt │ │ ├── InstantTaskExecutorExtension.kt │ │ └── CoroutinesTestDispatcherExtension.kt └── build.gradle.kts ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── app ├── src │ └── main │ │ ├── res │ │ ├── mipmap-hdpi │ │ │ ├── ic_launcher.png │ │ │ └── ic_launcher_round.png │ │ ├── mipmap-mdpi │ │ │ ├── ic_launcher.png │ │ │ └── ic_launcher_round.png │ │ ├── mipmap-xhdpi │ │ │ ├── ic_launcher.png │ │ │ └── ic_launcher_round.png │ │ ├── mipmap-xxhdpi │ │ │ ├── ic_launcher.png │ │ │ └── ic_launcher_round.png │ │ ├── mipmap-xxxhdpi │ │ │ ├── ic_launcher.png │ │ │ └── ic_launcher_round.png │ │ ├── mipmap-anydpi-v26 │ │ │ ├── ic_launcher.xml │ │ │ └── ic_launcher_round.xml │ │ ├── drawable-v24 │ │ │ └── ic_launcher_foreground.xml │ │ └── drawable │ │ │ └── ic_launcher_background.xml │ │ ├── AndroidManifest.xml │ │ └── java │ │ └── app │ │ └── droidster │ │ └── App.kt ├── build.gradle.kts └── proguard-rules.pro ├── settings.gradle.kts ├── .gitignore ├── android.gradle ├── README.md ├── gradle.properties ├── gradlew.bat ├── gradlew └── LICENSE /base/consumer-rules.pro: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /feature/consumer-rules.pro: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /di/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /feature/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /base/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /test-core/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /base/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | Template 3 | 4 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rahulsainani/android-template/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rahulsainani/android-template/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rahulsainani/android-template/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rahulsainani/android-template/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rahulsainani/android-template/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "Template" 2 | include( 3 | ":app", 4 | ":base", 5 | ":di", 6 | ":feature", 7 | ":test-core" 8 | ) -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rahulsainani/android-template/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rahulsainani/android-template/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rahulsainani/android-template/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rahulsainani/android-template/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rahulsainani/android-template/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rahulsainani/android-template/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /feature/src/main/java/template/feature/FeatureViewModel.kt: -------------------------------------------------------------------------------- 1 | package template.feature 2 | 3 | import androidx.lifecycle.ViewModel 4 | import javax.inject.Inject 5 | 6 | class FeatureViewModel @Inject constructor() : ViewModel() 7 | -------------------------------------------------------------------------------- /di/src/main/java/template/di/AppComponentProvider.kt: -------------------------------------------------------------------------------- 1 | package template.di 2 | 3 | import template.di.component.ApplicationComponent 4 | 5 | interface AppComponentProvider { 6 | fun provideAppComponent(): ApplicationComponent 7 | } 8 | -------------------------------------------------------------------------------- /base/src/main/java/template/base/di/ApplicationContext.kt: -------------------------------------------------------------------------------- 1 | package template.base.di 2 | 3 | import javax.inject.Qualifier 4 | import kotlin.annotation.AnnotationRetention.RUNTIME 5 | 6 | @Qualifier 7 | @Retention(RUNTIME) 8 | annotation class ApplicationContext 9 | -------------------------------------------------------------------------------- /base/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #008577 4 | #00574B 5 | #D81B60 6 | 7 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Sat Aug 24 12:21:09 CEST 2019 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.2.1-all.zip 7 | -------------------------------------------------------------------------------- /base/src/main/res/values/dimens.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 8dp 5 | 16dp 6 | 24dp 7 | 32dp 8 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /test-core/src/main/java/template/test/core/InstantTask.kt: -------------------------------------------------------------------------------- 1 | package template.test.core 2 | 3 | import javax.inject.Qualifier 4 | import org.junit.jupiter.api.extension.ExtendWith 5 | 6 | @Qualifier 7 | @Retention(AnnotationRetention.RUNTIME) 8 | @ExtendWith(InstantTaskExecutorExtension::class) 9 | annotation class InstantTask 10 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /di/src/main/java/template/di/ViewModelKey.kt: -------------------------------------------------------------------------------- 1 | package template.di 2 | 3 | import androidx.lifecycle.ViewModel 4 | import dagger.MapKey 5 | import kotlin.reflect.KClass 6 | 7 | @Target( 8 | AnnotationTarget.FUNCTION, 9 | AnnotationTarget.PROPERTY_GETTER, 10 | AnnotationTarget.PROPERTY_SETTER 11 | ) 12 | @MapKey 13 | annotation class ViewModelKey(val value: KClass) 14 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Gradle files 2 | .gradle/ 3 | build/ 4 | 5 | # Local configuration file (sdk path, etc) 6 | local.properties 7 | 8 | # Android Studio Navigation editor temp files 9 | .navigation/ 10 | 11 | # Android Studio captures folder 12 | captures/ 13 | 14 | # IntelliJ 15 | *.iml 16 | .idea 17 | 18 | # External native build folder generated in Android Studio 2.2 and later 19 | .externalNativeBuild -------------------------------------------------------------------------------- /di/src/main/java/template/di/PerActivity.kt: -------------------------------------------------------------------------------- 1 | package template.di 2 | 3 | import javax.inject.Scope 4 | import kotlin.annotation.AnnotationRetention.RUNTIME 5 | 6 | /** 7 | * A scoping annotation to permit objects whose lifetime should 8 | * conform to the life of the activity to be memorized in the 9 | * correct component. 10 | */ 11 | @Scope 12 | @Retention(RUNTIME) 13 | annotation class PerActivity 14 | -------------------------------------------------------------------------------- /test-core/src/main/java/template/test/core/CoroutinesExtension.kt: -------------------------------------------------------------------------------- 1 | package template.test.core 2 | 3 | import kotlinx.coroutines.ExperimentalCoroutinesApi 4 | import org.junit.jupiter.api.extension.ExtendWith 5 | import javax.inject.Qualifier 6 | 7 | @ExperimentalCoroutinesApi 8 | @Qualifier 9 | @Retention(AnnotationRetention.RUNTIME) 10 | @ExtendWith(CoroutinesTestDispatcherExtension::class) 11 | annotation class CoroutinesExtension 12 | -------------------------------------------------------------------------------- /di/src/main/java/template/di/module/ViewModelFactoryModule.kt: -------------------------------------------------------------------------------- 1 | package template.di.module 2 | 3 | import androidx.lifecycle.ViewModelProvider 4 | import dagger.Binds 5 | import dagger.Module 6 | import template.di.ViewModelFactory 7 | 8 | @Module 9 | abstract class ViewModelFactoryModule { 10 | 11 | @Binds 12 | internal abstract fun bindViewModelFactory( 13 | viewModelFactory: ViewModelFactory 14 | ): ViewModelProvider.Factory 15 | } 16 | -------------------------------------------------------------------------------- /base/src/main/res/values/styles.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /app/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("com.android.application") 3 | kotlin("android") 4 | } 5 | apply(from = "${rootProject.projectDir}/android.gradle") 6 | 7 | dependencies { 8 | implementation(Libs.kotlin_stdlib_jdk7) 9 | implementation(Libs.coreKtx) 10 | 11 | implementation(project(Modules.base)) 12 | implementation(project(Modules.di)) 13 | implementation(project(Modules.feature)) 14 | 15 | implementation(Libs.timber) 16 | } 17 | -------------------------------------------------------------------------------- /test-core/src/main/java/template/test/core/CoroutineTest.kt: -------------------------------------------------------------------------------- 1 | package template.test.core 2 | 3 | import kotlinx.coroutines.ExperimentalCoroutinesApi 4 | import kotlinx.coroutines.test.TestCoroutineDispatcher 5 | import kotlinx.coroutines.test.TestCoroutineScope 6 | import org.junit.jupiter.api.extension.ExtendWith 7 | 8 | @ExperimentalCoroutinesApi 9 | @ExtendWith(CoroutinesTestDispatcherExtension::class) 10 | interface CoroutineTest { 11 | var testScope: TestCoroutineScope 12 | var dispatcher: TestCoroutineDispatcher 13 | } 14 | -------------------------------------------------------------------------------- /test-core/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("com.android.library") 3 | kotlin("android") 4 | } 5 | apply(from = "${rootProject.projectDir}/android.gradle") 6 | 7 | dependencies { 8 | implementation(Libs.kotlin_stdlib_jdk7) 9 | implementation(Libs.dagger) 10 | implementation(Libs.lifecycleExtensions) 11 | 12 | api(Libs.junitJupiter) 13 | testRuntimeOnly(Libs.junitJupiterEngine) 14 | api(Libs.mockitoKotlin) 15 | api(Libs.mockitoInline) 16 | api(Libs.assertJCore) 17 | api(Libs.coroutinesTest) 18 | } 19 | -------------------------------------------------------------------------------- /feature/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /feature/src/main/java/template/feature/di/FeatureModule.kt: -------------------------------------------------------------------------------- 1 | package template.feature.di 2 | 3 | import androidx.lifecycle.ViewModel 4 | import dagger.Binds 5 | import dagger.Module 6 | import dagger.multibindings.IntoMap 7 | import template.di.ViewModelKey 8 | import template.feature.FeatureViewModel 9 | 10 | @Module 11 | object FeatureModule { 12 | 13 | @Module 14 | abstract class FeatureViewModelModule { 15 | @Binds 16 | @IntoMap 17 | @ViewModelKey(FeatureViewModel::class) 18 | abstract fun bindViewModel(myViewModel: FeatureViewModel): ViewModel 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /base/src/main/java/template/base/extensions/CoroutinesExtensions.kt: -------------------------------------------------------------------------------- 1 | package template.base.extensions 2 | 3 | import kotlinx.coroutines.CancellationException 4 | import kotlinx.coroutines.CoroutineScope 5 | import kotlinx.coroutines.launch 6 | import timber.log.Timber 7 | 8 | fun CoroutineScope.launchSafe( 9 | action: suspend () -> Unit, 10 | onError: (Throwable) -> Unit = {} 11 | ) { 12 | launch { 13 | try { 14 | action() 15 | } catch (e: CancellationException) { 16 | Timber.d(e, "Job cancelled") 17 | } catch (e: Exception) { 18 | onError(e) 19 | } 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /feature/src/main/java/template/feature/di/FeatureComponent.kt: -------------------------------------------------------------------------------- 1 | package template.feature.di 2 | 3 | import dagger.Component 4 | import template.di.PerActivity 5 | import template.di.component.ApplicationComponent 6 | import template.di.module.ViewModelFactoryModule 7 | import template.feature.FeatureActivity 8 | 9 | @PerActivity 10 | @Component( 11 | dependencies = [ApplicationComponent::class], 12 | modules = [ 13 | ViewModelFactoryModule::class, 14 | FeatureModule::class, 15 | FeatureModule.FeatureViewModelModule::class 16 | ] 17 | ) 18 | interface FeatureComponent { 19 | fun inject(activity: FeatureActivity) 20 | } 21 | -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 6 | 7 | 17 | 18 | -------------------------------------------------------------------------------- /di/src/main/java/template/di/AppComponentInjectHelper.kt: -------------------------------------------------------------------------------- 1 | package template.di 2 | 3 | import android.content.Context 4 | import template.di.component.ApplicationComponent 5 | 6 | object AppComponentInjectHelper { 7 | fun provideAppComponent(applicationContext: Context): ApplicationComponent { 8 | return if (applicationContext is AppComponentProvider) { 9 | (applicationContext as AppComponentProvider).provideAppComponent() 10 | } else { 11 | throw IllegalStateException(MESSAGE) 12 | } 13 | } 14 | 15 | private const val MESSAGE = 16 | "The application context you have passed does not implement AppComponentProvider" 17 | } 18 | -------------------------------------------------------------------------------- /di/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("com.android.library") 3 | kotlin("android") 4 | kotlin("kapt") 5 | kotlin("android.extensions") 6 | } 7 | apply(from = "${rootProject.projectDir}/android.gradle") 8 | 9 | dependencies { 10 | implementation(project(Modules.base)) 11 | 12 | implementation(Libs.kotlin_stdlib_jdk7) 13 | implementation(Libs.coreKtx) 14 | 15 | implementation(Libs.timber) 16 | 17 | implementation(Libs.dagger) 18 | kapt(Libs.daggerCompiler) 19 | 20 | implementation(Libs.lifecycleViewmodel) 21 | 22 | implementation(Libs.okHttp) 23 | implementation(Libs.loggingInterceptor) 24 | implementation(Libs.retrofitMoshi) 25 | implementation(Libs.retrofit) 26 | implementation(Libs.moshi) 27 | } 28 | -------------------------------------------------------------------------------- /base/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("com.android.library") 3 | kotlin("android") 4 | kotlin("kapt") 5 | kotlin("android.extensions") 6 | } 7 | apply(from = "${rootProject.projectDir}/android.gradle") 8 | 9 | dependencies { 10 | // Kotlin 11 | implementation(Libs.kotlin_stdlib_jdk7) 12 | implementation(Libs.coreKtx) 13 | implementation(Libs.coroutinesCore) 14 | 15 | // Logging 16 | implementation(Libs.timber) 17 | 18 | // Dependency Injection 19 | implementation(Libs.dagger) 20 | kapt(Libs.daggerCompiler) 21 | 22 | // AndroidX 23 | implementation(Libs.lifecycleViewmodel) 24 | 25 | // Testing 26 | testImplementation(project(Modules.testCore)) 27 | testRuntimeOnly(Libs.junitJupiterEngine) 28 | } 29 | -------------------------------------------------------------------------------- /di/src/main/java/template/di/component/ApplicationComponent.kt: -------------------------------------------------------------------------------- 1 | package template.di.component 2 | 3 | import android.content.Context 4 | import dagger.BindsInstance 5 | import dagger.Component 6 | import javax.inject.Singleton 7 | import retrofit2.Retrofit 8 | import template.base.di.ApplicationContext 9 | import template.di.module.NetworkModule 10 | 11 | @Singleton 12 | @Component(modules = [NetworkModule::class]) 13 | interface ApplicationComponent { 14 | 15 | @ApplicationContext 16 | fun context(): Context 17 | 18 | fun retrofit(): Retrofit 19 | 20 | @Component.Builder 21 | interface Builder { 22 | @BindsInstance 23 | fun applicationContext(@ApplicationContext applicationContext: Context): Builder 24 | 25 | fun build(): ApplicationComponent 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile 22 | -------------------------------------------------------------------------------- /base/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile 22 | -------------------------------------------------------------------------------- /feature/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile 22 | -------------------------------------------------------------------------------- /feature/src/main/res/layout/activity_feature.xml: -------------------------------------------------------------------------------- 1 | 2 | 8 | 9 | 17 | 18 | -------------------------------------------------------------------------------- /app/src/main/java/app/droidster/App.kt: -------------------------------------------------------------------------------- 1 | package app.droidster 2 | 3 | import android.app.Application 4 | import template.di.AppComponentProvider 5 | import template.di.component.ApplicationComponent 6 | import template.di.component.DaggerApplicationComponent 7 | import timber.log.Timber 8 | 9 | class App : Application(), AppComponentProvider { 10 | 11 | private val applicationComponent by lazy { 12 | DaggerApplicationComponent 13 | .builder() 14 | .applicationContext(this) 15 | .build() 16 | } 17 | 18 | override fun provideAppComponent(): ApplicationComponent = applicationComponent 19 | 20 | override fun onCreate() { 21 | super.onCreate() 22 | plantTimber() 23 | } 24 | 25 | private fun plantTimber() { 26 | if (BuildConfig.DEBUG) { 27 | Timber.plant(Timber.DebugTree()) 28 | } 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /android.gradle: -------------------------------------------------------------------------------- 1 | android { 2 | compileSdkVersion Versions.compileSdk 3 | 4 | defaultConfig { 5 | minSdkVersion Versions.minSdk 6 | targetSdkVersion Versions.targetSdk 7 | versionCode = Versions.appVersionCode 8 | versionName = Versions.appVersionName 9 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" 10 | } 11 | 12 | buildTypes { 13 | release { 14 | minifyEnabled false 15 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 16 | } 17 | } 18 | 19 | compileOptions { 20 | sourceCompatibility JavaVersion.VERSION_1_8 21 | targetCompatibility JavaVersion.VERSION_1_8 22 | } 23 | } 24 | 25 | apply plugin: 'org.jlleitschuh.gradle.ktlint' 26 | ktlint { 27 | version = Versions.ktlint 28 | debug = true 29 | android = true 30 | } -------------------------------------------------------------------------------- /di/src/main/java/template/di/ViewModelFactory.kt: -------------------------------------------------------------------------------- 1 | package template.di 2 | 3 | import androidx.lifecycle.ViewModel 4 | import androidx.lifecycle.ViewModelProvider 5 | import javax.inject.Inject 6 | import javax.inject.Provider 7 | 8 | @Suppress("UNCHECKED_CAST") 9 | class ViewModelFactory @Inject constructor( 10 | private val viewModelsMap: Map, @JvmSuppressWildcards Provider> 11 | ) : ViewModelProvider.Factory { 12 | 13 | override fun create(modelClass: Class): T { 14 | val creator = viewModelsMap[modelClass] ?: viewModelsMap.asIterable().firstOrNull { 15 | modelClass.isAssignableFrom(it.key) 16 | }?.value ?: throw IllegalArgumentException("unknown model class $modelClass") 17 | return try { 18 | creator.get() as T 19 | } catch (e: Exception) { 20 | throw RuntimeException(e) 21 | } 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /feature/src/main/java/template/feature/FeatureActivity.kt: -------------------------------------------------------------------------------- 1 | package template.feature 2 | 3 | import android.os.Bundle 4 | import androidx.appcompat.app.AppCompatActivity 5 | import androidx.lifecycle.ViewModelProvider 6 | import javax.inject.Inject 7 | import template.di.AppComponentInjectHelper 8 | import template.feature.di.DaggerFeatureComponent 9 | 10 | class FeatureActivity : AppCompatActivity() { 11 | 12 | @Inject 13 | lateinit var viewModelFactory: ViewModelProvider.Factory 14 | 15 | private lateinit var viewModel: FeatureViewModel 16 | 17 | override fun onCreate(savedInstanceState: Bundle?) { 18 | super.onCreate(savedInstanceState) 19 | setContentView(R.layout.activity_feature) 20 | 21 | inject() 22 | viewModel = ViewModelProvider(this, viewModelFactory)[FeatureViewModel::class.java] 23 | } 24 | 25 | private fun inject() = 26 | DaggerFeatureComponent 27 | .builder() 28 | .applicationComponent(AppComponentInjectHelper.provideAppComponent(applicationContext)) 29 | .build() 30 | .inject(this) 31 | } 32 | -------------------------------------------------------------------------------- /test-core/src/main/java/template/test/core/InstantTaskExecutorExtension.kt: -------------------------------------------------------------------------------- 1 | package template.test.core 2 | 3 | import android.annotation.SuppressLint 4 | import androidx.arch.core.executor.ArchTaskExecutor 5 | import androidx.arch.core.executor.TaskExecutor 6 | import org.junit.jupiter.api.extension.AfterEachCallback 7 | import org.junit.jupiter.api.extension.BeforeEachCallback 8 | import org.junit.jupiter.api.extension.ExtensionContext 9 | 10 | @SuppressLint("RestrictedApi") 11 | class InstantTaskExecutorExtension : BeforeEachCallback, AfterEachCallback { 12 | 13 | override fun beforeEach(context: ExtensionContext?) { 14 | ArchTaskExecutor.getInstance().setDelegate(object : TaskExecutor() { 15 | 16 | override fun executeOnDiskIO(runnable: Runnable) = runnable.run() 17 | 18 | override fun isMainThread(): Boolean = true 19 | 20 | override fun postToMainThread(runnable: Runnable) = runnable.run() 21 | }) 22 | } 23 | 24 | override fun afterEach(context: ExtensionContext?) { 25 | ArchTaskExecutor.getInstance().setDelegate(null) 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /feature/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("com.android.library") 3 | kotlin("android") 4 | kotlin("kapt") 5 | kotlin("android.extensions") 6 | } 7 | apply(from = "${rootProject.projectDir}/android.gradle") 8 | 9 | dependencies { 10 | implementation(project(Modules.base)) 11 | implementation(project(Modules.di)) 12 | 13 | implementation(Libs.kotlin_stdlib_jdk7) 14 | implementation(Libs.coreKtx) 15 | 16 | // Logging 17 | implementation(Libs.timber) 18 | 19 | // Dependency Injection 20 | implementation(Libs.dagger) 21 | kapt(Libs.daggerCompiler) 22 | 23 | // AndroidX 24 | implementation(Libs.lifecycleViewmodel) 25 | implementation(Libs.lifecycleCommonJava8) 26 | implementation(Libs.lifecycleExtensions) 27 | implementation(Libs.material) 28 | implementation(Libs.appCompat) 29 | implementation(Libs.constraintLayout) 30 | implementation(Libs.recyclerview) 31 | 32 | // Networking 33 | implementation(Libs.retrofit) 34 | 35 | // Testing 36 | testImplementation(project(Modules.testCore)) 37 | testRuntimeOnly(Libs.junitJupiterEngine) 38 | } 39 | -------------------------------------------------------------------------------- /di/src/main/java/template/di/module/NetworkModule.kt: -------------------------------------------------------------------------------- 1 | package template.di.module 2 | 3 | import dagger.Module 4 | import dagger.Provides 5 | import javax.inject.Singleton 6 | import okhttp3.OkHttpClient 7 | import okhttp3.logging.HttpLoggingInterceptor 8 | import retrofit2.Retrofit 9 | import retrofit2.converter.moshi.MoshiConverterFactory 10 | 11 | @Module 12 | object NetworkModule { 13 | 14 | private const val BASE_URL = "https://github.com" 15 | 16 | @Provides 17 | @Singleton 18 | fun provideLoggingInterceptor(): HttpLoggingInterceptor { 19 | val loggingInterceptor = HttpLoggingInterceptor() 20 | loggingInterceptor.level = HttpLoggingInterceptor.Level.BODY 21 | return loggingInterceptor 22 | } 23 | 24 | @Provides 25 | @Singleton 26 | fun okHttpClient(httpLoggingInterceptor: HttpLoggingInterceptor): OkHttpClient = OkHttpClient 27 | .Builder() 28 | .addInterceptor(httpLoggingInterceptor) 29 | .build() 30 | 31 | @Provides 32 | @Singleton 33 | fun retrofit(okHttpClient: OkHttpClient): Retrofit = 34 | Retrofit.Builder() 35 | .baseUrl(BASE_URL) 36 | .client(okHttpClient) 37 | .addConverterFactory(MoshiConverterFactory.create()) 38 | .build() 39 | } 40 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Template 2 | 3 | This is a basic Android project template that consists of 5 modules: 4 | - Base 5 | - DI 6 | - App 7 | - Feature 8 | - Test-Core 9 | 10 | To use the template: 11 | 1. Update the package name in project's build.gradle. 12 | 2. Replace "Template" to your project name 13 | 3. Replace "template" in package names. 14 | 4. Replace "feature" to your feature name and similarly for the activity and the layout. 15 | 16 | 17 | The template uses Kotlin and the following libraries: 18 | 19 | - Ktx 20 | - AppCompat 21 | - Material Components 22 | - RecyclerView 23 | - Constraint Layout 24 | - AAC ViewModel and Lifecycle 25 | - Dagger 26 | - OkHttp 27 | - LoggingInterceptor 28 | - Retrofit 29 | - Moshi 30 | - Timber 31 | - Findbugs 32 | - JUnitJupiter 33 | - MockitoKotlin 34 | - AssertJ 35 | 36 | The template uses Ktlint for formatting and lint checks. 37 | 38 | ## License 39 | 40 | ``` 41 | Copyright 2020 Rahul Sainani 42 | 43 | Licensed under the Apache License, Version 2.0 (the "License"); 44 | you may not use this file except in compliance with the License. 45 | You may obtain a copy of the License at 46 | 47 | http://www.apache.org/licenses/LICENSE-2.0 48 | 49 | Unless required by applicable law or agreed to in writing, software 50 | distributed under the License is distributed on an "AS IS" BASIS, 51 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 52 | See the License for the specific language governing permissions and 53 | limitations under the License. 54 | ``` 55 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | # IDE (e.g. Android Studio) users: 3 | # Gradle settings configured through the IDE *will override* 4 | # any settings specified in this file. 5 | # For more details on how to configure your build environment visit 6 | # http://www.gradle.org/docs/current/userguide/build_environment.html 7 | # Specifies the JVM arguments used for the daemon process. 8 | # The setting is particularly useful for tweaking memory settings. 9 | org.gradle.jvmargs=-Xmx1536m 10 | # When configured, Gradle will run in incubating parallel mode. 11 | # This option should only be used with decoupled projects. More details, visit 12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 13 | # org.gradle.parallel=true 14 | # AndroidX package structure to make it clearer which packages are bundled with the 15 | # Android operating system, and which are packaged with your app's APK 16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn 17 | android.useAndroidX=true 18 | # Automatically convert third-party libraries to use AndroidX 19 | android.enableJetifier=true 20 | # Kotlin code style for this project: "official" or "obsolete": 21 | kotlin.code.style=official 22 | # run kapt tasks in parallel 23 | kapt.use.worker.api=true 24 | # compile avoidance when project files are unchanged or dependency changes are ABI compatible, e.g 25 | # changes in method bodies only 26 | kapt.include.compile.classpath=false 27 | # incremental compilation and annotation processing 28 | kapt.incremental=true 29 | kapt.incremental.apt=true -------------------------------------------------------------------------------- /test-core/src/main/java/template/test/core/CoroutinesTestDispatcherExtension.kt: -------------------------------------------------------------------------------- 1 | package template.test.core 2 | 3 | import kotlinx.coroutines.Dispatchers 4 | import kotlinx.coroutines.ExperimentalCoroutinesApi 5 | import kotlinx.coroutines.test.TestCoroutineDispatcher 6 | import kotlinx.coroutines.test.TestCoroutineScope 7 | import kotlinx.coroutines.test.resetMain 8 | import kotlinx.coroutines.test.setMain 9 | import org.junit.jupiter.api.extension.AfterAllCallback 10 | import org.junit.jupiter.api.extension.AfterEachCallback 11 | import org.junit.jupiter.api.extension.BeforeAllCallback 12 | import org.junit.jupiter.api.extension.ExtensionContext 13 | import org.junit.jupiter.api.extension.TestInstancePostProcessor 14 | 15 | @ExperimentalCoroutinesApi 16 | class CoroutinesTestDispatcherExtension : 17 | TestInstancePostProcessor, BeforeAllCallback, AfterEachCallback, AfterAllCallback { 18 | 19 | private val dispatcher = TestCoroutineDispatcher() 20 | private val testScope = TestCoroutineScope(dispatcher) 21 | 22 | override fun postProcessTestInstance(testInstance: Any?, context: ExtensionContext?) { 23 | (testInstance as? CoroutineTest)?.let { coroutineTest -> 24 | coroutineTest.testScope = testScope 25 | coroutineTest.dispatcher = dispatcher 26 | } 27 | } 28 | 29 | override fun beforeAll(context: ExtensionContext?) { 30 | Dispatchers.setMain(dispatcher) 31 | } 32 | 33 | override fun afterEach(context: ExtensionContext?) { 34 | testScope.cleanupTestCoroutines() 35 | } 36 | 37 | override fun afterAll(context: ExtensionContext?) { 38 | Dispatchers.resetMain() 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 12 | 13 | 19 | 22 | 25 | 26 | 27 | 28 | 34 | 35 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2020 Rahul Sainani 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------