├── Gemfile ├── .editorconfig ├── settings.gradle ├── app ├── src │ ├── test │ │ ├── resources │ │ │ └── responses │ │ │ │ ├── failure_login.json │ │ │ │ └── success_get_jokes.json │ │ └── java │ │ │ └── com │ │ │ └── stackinflow │ │ │ └── androidapptemplate │ │ │ ├── ExampleUnitTest.kt │ │ │ ├── util │ │ │ ├── FileUtil.kt │ │ │ ├── MockWebServerFailureDispatcher.kt │ │ │ ├── MockWebServerSuccessDispatcher.kt │ │ │ ├── LiveDataTestUtil.kt │ │ │ └── TestCoroutineRule.kt │ │ │ └── ui │ │ │ └── MainViewModelTest.kt │ ├── 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 │ │ │ ├── values │ │ │ │ ├── strings.xml │ │ │ │ ├── colors.xml │ │ │ │ └── themes.xml │ │ │ ├── mipmap-anydpi-v26 │ │ │ │ ├── ic_launcher.xml │ │ │ │ └── ic_launcher_round.xml │ │ │ ├── values-night │ │ │ │ └── themes.xml │ │ │ ├── drawable-v24 │ │ │ │ └── ic_launcher_foreground.xml │ │ │ └── drawable │ │ │ │ └── ic_launcher_background.xml │ │ ├── java │ │ │ └── com │ │ │ │ └── stackinflow │ │ │ │ └── androidapptemplate │ │ │ │ ├── network │ │ │ │ ├── Endpoints.kt │ │ │ │ ├── model │ │ │ │ │ └── JokesResponse.kt │ │ │ │ └── api │ │ │ │ │ └── JokeApiService.kt │ │ │ │ ├── di │ │ │ │ ├── AppModule.kt │ │ │ │ └── NetworkModule.kt │ │ │ │ ├── ui │ │ │ │ ├── ViewState.kt │ │ │ │ ├── MainViewModel.kt │ │ │ │ └── MainActivity.kt │ │ │ │ ├── util │ │ │ │ └── CrashReportingTree.kt │ │ │ │ ├── repository │ │ │ │ └── JokeRepo.kt │ │ │ │ └── AppTemplateApplication.kt │ │ └── AndroidManifest.xml │ └── androidTest │ │ └── java │ │ └── com │ │ └── stackinflow │ │ └── androidapptemplate │ │ ├── ui │ │ └── MainActivityTest.kt │ │ ├── CustomTestRunner.kt │ │ └── ExampleInstrumentedTest.kt ├── proguard-rules.pro └── build.gradle ├── art └── banner.png ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── fastlane ├── Appfile └── Fastfile ├── .idea └── codeStyles │ ├── codeStyleConfig.xml │ └── Project.xml ├── team-props ├── git-hook.gradle └── pre-commit ├── gradle.properties ├── .gitignore ├── README.md ├── .circleci └── config.yml ├── gradlew.bat ├── Gemfile.lock ├── gradlew └── LICENSE /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | 3 | gem "fastlane" -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | [*.{kt, kts}] 2 | indent_size = 2 3 | insert_final_newline = true -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = "AndroidAppTemplate" 2 | include ':app' 3 | -------------------------------------------------------------------------------- /app/src/test/resources/responses/failure_login.json: -------------------------------------------------------------------------------- 1 | { 2 | "data": {}, 3 | "message": "" 4 | } -------------------------------------------------------------------------------- /art/banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stackinflow/AndroidAppTemplate/HEAD/art/banner.png -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stackinflow/AndroidAppTemplate/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stackinflow/AndroidAppTemplate/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stackinflow/AndroidAppTemplate/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stackinflow/AndroidAppTemplate/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stackinflow/AndroidAppTemplate/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stackinflow/AndroidAppTemplate/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stackinflow/AndroidAppTemplate/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/stackinflow/AndroidAppTemplate/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/stackinflow/AndroidAppTemplate/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/stackinflow/AndroidAppTemplate/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/stackinflow/AndroidAppTemplate/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | AndroidAppTemplate 3 | Get Jokes 4 | -------------------------------------------------------------------------------- /fastlane/Appfile: -------------------------------------------------------------------------------- 1 | json_key_file("") # Path to the json secret file - Follow https://docs.fastlane.tools/actions/supply/#setup to get one 2 | package_name("com.stackinflow.androidapptemplate") 3 | -------------------------------------------------------------------------------- /app/src/main/java/com/stackinflow/androidapptemplate/network/Endpoints.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.network 2 | 3 | object Endpoints { 4 | 5 | const val GET_JOKES = "/jokes/random/5" 6 | } 7 | -------------------------------------------------------------------------------- /.idea/codeStyles/codeStyleConfig.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | -------------------------------------------------------------------------------- /team-props/git-hook.gradle: -------------------------------------------------------------------------------- 1 | task installGitHook(type: Copy) { 2 | from new File(rootProject.rootDir, 'team-props/pre-commit') 3 | into { new File(rootProject.rootDir, '.git/hooks') } 4 | fileMode 0777 5 | } 6 | tasks.getByPath(':app:preBuild').dependsOn installGitHook -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Fri Aug 28 02:56:05 IST 2020 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.8-rc-1-bin.zip 7 | -------------------------------------------------------------------------------- /app/src/main/java/com/stackinflow/androidapptemplate/di/AppModule.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.di 2 | 3 | import dagger.Module 4 | import dagger.hilt.InstallIn 5 | import dagger.hilt.android.components.ApplicationComponent 6 | 7 | @InstallIn(ApplicationComponent::class) 8 | @Module 9 | class AppModule 10 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/java/com/stackinflow/androidapptemplate/ui/ViewState.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.ui 2 | 3 | sealed class ViewState { 4 | object Idle : ViewState() 5 | data class Success(val data: T? = null) : ViewState() 6 | object Loading : ViewState() 7 | data class Error(val error: T? = null) : ViewState() 8 | } 9 | -------------------------------------------------------------------------------- /app/src/main/java/com/stackinflow/androidapptemplate/network/model/JokesResponse.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.network.model 2 | 3 | data class JokesResponse( 4 | val type: String, 5 | val value: List 6 | ) 7 | 8 | data class Joke( 9 | val id: Int, 10 | val joke: String, 11 | val categories: List 12 | ) 13 | -------------------------------------------------------------------------------- /team-props/pre-commit: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | echo "Running static analysis using ktlint..." 4 | 5 | ./gradlew ktlintCheck --daemon 6 | 7 | status=$? 8 | 9 | if [ "$status" = 0 ] ; then 10 | echo "Static analysis found no problems." 11 | exit 0 12 | else 13 | echo 1>&2 "Static analysis found violations it could not fix." 14 | exit 1 15 | fi -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #FF03DAC5 7 | #FF018786 8 | #FF000000 9 | #FFFFFFFF 10 | -------------------------------------------------------------------------------- /app/src/main/java/com/stackinflow/androidapptemplate/network/api/JokeApiService.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.network.api 2 | 3 | import com.stackinflow.androidapptemplate.network.Endpoints 4 | import com.stackinflow.androidapptemplate.network.model.JokesResponse 5 | import retrofit2.Response 6 | import retrofit2.http.GET 7 | 8 | interface JokeApiService { 9 | 10 | @GET(Endpoints.GET_JOKES) 11 | suspend fun getJokes(): Response 12 | } 13 | -------------------------------------------------------------------------------- /app/src/test/java/com/stackinflow/androidapptemplate/ExampleUnitTest.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate 2 | 3 | import org.junit.Assert.assertEquals 4 | import org.junit.Test 5 | 6 | /** 7 | * Example local unit test, which will execute on the development machine (host). 8 | * 9 | * See [testing documentation](http://d.android.com/tools/testing). 10 | */ 11 | class ExampleUnitTest { 12 | @Test 13 | fun addition_isCorrect() { 14 | assertEquals(4, 2 + 2) 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /app/src/test/java/com/stackinflow/androidapptemplate/util/FileUtil.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.util 2 | 3 | import java.io.BufferedReader 4 | 5 | object FileUtil { 6 | 7 | fun loadText(resourceName: String): String = readResource(resourceName).use { 8 | it.readText() 9 | } 10 | 11 | private fun readResource(resourceName: String): BufferedReader { 12 | return javaClass.classLoader!!.getResource(resourceName) 13 | .openStream() 14 | .bufferedReader() 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /app/src/main/java/com/stackinflow/androidapptemplate/util/CrashReportingTree.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.util 2 | 3 | import android.util.Log 4 | import timber.log.Timber 5 | 6 | class CrashReportingTree : Timber.Tree() { 7 | 8 | override fun isLoggable(tag: String?, priority: Int): Boolean { 9 | return priority >= Log.INFO 10 | } 11 | 12 | override fun log(priority: Int, tag: String?, message: String, t: Throwable?) { 13 | /* 14 | use your crashlytics tools 15 | */ 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /app/src/androidTest/java/com/stackinflow/androidapptemplate/ui/MainActivityTest.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.ui 2 | 3 | import androidx.test.core.app.ActivityScenario 4 | import dagger.hilt.android.testing.HiltAndroidRule 5 | import dagger.hilt.android.testing.HiltAndroidTest 6 | import org.junit.Rule 7 | import org.junit.Test 8 | 9 | @HiltAndroidTest 10 | class MainActivityTest { 11 | 12 | @get:Rule 13 | var hiltRule = HiltAndroidRule(this) 14 | 15 | @Test 16 | fun happy_path() { 17 | ActivityScenario.launch(MainActivity::class.java) 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /app/src/androidTest/java/com/stackinflow/androidapptemplate/CustomTestRunner.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate 2 | 3 | import android.app.Application 4 | import android.content.Context 5 | import androidx.test.runner.AndroidJUnitRunner 6 | import dagger.hilt.android.testing.HiltTestApplication 7 | 8 | class CustomTestRunner : AndroidJUnitRunner() { 9 | 10 | override fun newApplication( 11 | cl: ClassLoader?, 12 | className: String?, 13 | context: Context? 14 | ): Application { 15 | return super.newApplication(cl, HiltTestApplication::class.java.name, context) 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /app/src/main/java/com/stackinflow/androidapptemplate/repository/JokeRepo.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.repository 2 | 3 | import com.stackinflow.androidapptemplate.network.api.JokeApiService 4 | import com.stackinflow.androidapptemplate.network.model.JokesResponse 5 | import kotlinx.coroutines.Dispatchers 6 | import kotlinx.coroutines.withContext 7 | import retrofit2.Response 8 | import javax.inject.Inject 9 | 10 | class JokeRepo @Inject constructor( 11 | private val jokeApiService: JokeApiService 12 | ) { 13 | suspend fun getJokes(): Response { 14 | return withContext(Dispatchers.IO) { 15 | jokeApiService.getJokes() 16 | } 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /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 -------------------------------------------------------------------------------- /app/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /app/src/main/res/values-night/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /app/src/test/java/com/stackinflow/androidapptemplate/util/MockWebServerFailureDispatcher.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.util 2 | 3 | import com.stackinflow.androidapptemplate.network.Endpoints 4 | import okhttp3.mockwebserver.Dispatcher 5 | import okhttp3.mockwebserver.MockResponse 6 | import okhttp3.mockwebserver.RecordedRequest 7 | 8 | class MockWebServerFailureDispatcher : Dispatcher() { 9 | override fun dispatch(request: RecordedRequest): MockResponse { 10 | request.path?.let { 11 | return when { 12 | it.contains(Endpoints.GET_JOKES) -> { 13 | val content = FileUtil.loadText("responses/failure_login.json") 14 | MockResponse().setResponseCode(400) 15 | .setBody(content) 16 | } 17 | else -> MockResponse().setResponseCode(501) 18 | } 19 | } 20 | return MockResponse().setResponseCode(501) 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /app/src/test/java/com/stackinflow/androidapptemplate/util/MockWebServerSuccessDispatcher.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.util 2 | 3 | import com.stackinflow.androidapptemplate.network.Endpoints 4 | import okhttp3.mockwebserver.Dispatcher 5 | import okhttp3.mockwebserver.MockResponse 6 | import okhttp3.mockwebserver.RecordedRequest 7 | 8 | class MockWebServerSuccessDispatcher : Dispatcher() { 9 | override fun dispatch(request: RecordedRequest): MockResponse { 10 | request.path?.let { 11 | return when { 12 | it.contains(Endpoints.GET_JOKES) -> { 13 | val content = FileUtil.loadText("responses/success_login.json") 14 | MockResponse().setResponseCode(200) 15 | .setBody(content) 16 | } 17 | else -> MockResponse().setResponseCode(501) 18 | } 19 | } 20 | return MockResponse().setResponseCode(501) 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /app/src/androidTest/java/com/stackinflow/androidapptemplate/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate 2 | 3 | import androidx.test.platform.app.InstrumentationRegistry 4 | import dagger.hilt.android.testing.HiltAndroidRule 5 | import dagger.hilt.android.testing.HiltAndroidTest 6 | import org.junit.Assert.assertEquals 7 | import org.junit.Rule 8 | import org.junit.Test 9 | 10 | /** 11 | * Instrumented test, which will execute on an Android device. 12 | * 13 | * See [testing documentation](http://d.android.com/tools/testing). 14 | */ 15 | @HiltAndroidTest 16 | class ExampleInstrumentedTest { 17 | 18 | @get: Rule 19 | val rule = HiltAndroidRule(this) 20 | 21 | @Test 22 | fun useAppContext() { 23 | // Context of the app under test. 24 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext 25 | assertEquals("com.stackinflow.androidapptemplate", appContext.packageName) 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /fastlane/Fastfile: -------------------------------------------------------------------------------- 1 | # This file contains the fastlane.tools configuration 2 | # You can find the documentation at https://docs.fastlane.tools 3 | # 4 | # For a list of all available actions, check out 5 | # 6 | # https://docs.fastlane.tools/actions 7 | # 8 | # For a list of all available plugins, check out 9 | # 10 | # https://docs.fastlane.tools/plugins/available-plugins 11 | # 12 | 13 | # Uncomment the line if you want fastlane to automatically update itself 14 | # update_fastlane 15 | 16 | default_platform(:android) 17 | 18 | platform :android do 19 | desc "KtLint Check" 20 | lane :lint do 21 | gradle(task: "ktlintcheck") 22 | end 23 | 24 | desc "Runs all the tests" 25 | lane :test do 26 | gradle(task: "test") 27 | end 28 | 29 | desc "Build with debug apk" 30 | lane :build_debug do 31 | gradle(task: "clean assembleDebug") 32 | end 33 | 34 | desc "Build with release apk" 35 | lane :build_release do 36 | gradle(task: "clean assembleRelease") 37 | end 38 | end 39 | -------------------------------------------------------------------------------- /app/src/main/java/com/stackinflow/androidapptemplate/ui/MainViewModel.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.ui 2 | 3 | import androidx.hilt.lifecycle.ViewModelInject 4 | import androidx.lifecycle.LiveData 5 | import androidx.lifecycle.MutableLiveData 6 | import androidx.lifecycle.ViewModel 7 | import androidx.lifecycle.viewModelScope 8 | import com.stackinflow.androidapptemplate.repository.JokeRepo 9 | import kotlinx.coroutines.launch 10 | 11 | class MainViewModel @ViewModelInject constructor( 12 | private val jokeRepo: JokeRepo 13 | ) : ViewModel() { 14 | 15 | private val _viewState = MutableLiveData() 16 | val viewState: LiveData = _viewState 17 | 18 | fun getJokes() { 19 | viewModelScope.launch { 20 | val result = jokeRepo.getJokes() 21 | if (result.isSuccessful) { 22 | _viewState.postValue(ViewState.Success(result.body())) 23 | } else { 24 | _viewState.postValue(ViewState.Error(result.errorBody())) 25 | } 26 | } 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /app/src/test/resources/responses/success_get_jokes.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "success", 3 | "value": [ 4 | { 5 | "id": 175, 6 | "joke": "When Chuck Norris was a baby, he didn't suck his mother's breast. His mother served him whiskey, straight out of the bottle.", 7 | "categories": [] 8 | }, 9 | { 10 | "id": 419, 11 | "joke": "Count from one to ten. That's how long it would take Chuck Norris to kill you...Forty seven times.", 12 | "categories": [] 13 | }, 14 | { 15 | "id": 590, 16 | "joke": "Chuck Norris died before 20 years, Death doesn't have the courage to tell him yet.", 17 | "categories": [] 18 | }, 19 | { 20 | "id": 44, 21 | "joke": "Chuck Norris is the only man to ever defeat a brick wall in a game of tennis.", 22 | "categories": [] 23 | }, 24 | { 25 | "id": 326, 26 | "joke": "As an infant, Chuck Norris' parents gave him a toy hammer. He gave the world Stonehenge.", 27 | "categories": [] 28 | } 29 | ] 30 | } -------------------------------------------------------------------------------- /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=-Xmx2048m -Dfile.encoding=UTF-8 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 -------------------------------------------------------------------------------- /app/src/test/java/com/stackinflow/androidapptemplate/util/LiveDataTestUtil.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.util 2 | 3 | import androidx.annotation.VisibleForTesting 4 | import androidx.lifecycle.LiveData 5 | import androidx.lifecycle.Observer 6 | import java.util.concurrent.CountDownLatch 7 | import java.util.concurrent.TimeUnit 8 | import java.util.concurrent.TimeoutException 9 | 10 | @VisibleForTesting(otherwise = VisibleForTesting.NONE) 11 | fun LiveData.getOrAwaitValue( 12 | time: Long = 2, 13 | timeUnit: TimeUnit = TimeUnit.SECONDS, 14 | afterObserve: () -> Unit = {} 15 | ): T { 16 | var data: T? = null 17 | val latch = CountDownLatch(1) 18 | val observer = object : Observer { 19 | override fun onChanged(o: T?) { 20 | data = o 21 | latch.countDown() 22 | this@getOrAwaitValue.removeObserver(this) 23 | } 24 | } 25 | this.observeForever(observer) 26 | 27 | try { 28 | afterObserve.invoke() 29 | 30 | // Don't wait indefinitely if the LiveData is not set. 31 | if (!latch.await(time, timeUnit)) { 32 | throw TimeoutException("LiveData value was never set.") 33 | } 34 | } finally { 35 | this.removeObserver(observer) 36 | } 37 | 38 | @Suppress("UNCHECKED_CAST") 39 | return data as T 40 | } 41 | -------------------------------------------------------------------------------- /app/src/test/java/com/stackinflow/androidapptemplate/util/TestCoroutineRule.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.util 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.runBlockingTest 9 | import kotlinx.coroutines.test.setMain 10 | import org.junit.rules.TestRule 11 | import org.junit.runner.Description 12 | import org.junit.runners.model.Statement 13 | 14 | @ExperimentalCoroutinesApi 15 | class TestCoroutineRule : TestRule { 16 | 17 | private val testCoroutineDispatcher = TestCoroutineDispatcher() 18 | 19 | private val testCoroutineScope = TestCoroutineScope(testCoroutineDispatcher) 20 | 21 | override fun apply( 22 | base: Statement, 23 | description: Description? 24 | ) = object : Statement() { 25 | @Throws(Throwable::class) 26 | override fun evaluate() { 27 | Dispatchers.setMain(testCoroutineDispatcher) 28 | 29 | base.evaluate() 30 | 31 | Dispatchers.resetMain() 32 | testCoroutineScope.cleanupTestCoroutines() 33 | } 34 | } 35 | 36 | fun runBlockingTest(block: suspend TestCoroutineScope.() -> Unit) = 37 | testCoroutineScope.runBlockingTest { block() } 38 | } 39 | -------------------------------------------------------------------------------- /app/src/main/java/com/stackinflow/androidapptemplate/AppTemplateApplication.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate 2 | 3 | import android.app.Application 4 | import android.os.StrictMode 5 | import com.stackinflow.androidapptemplate.util.CrashReportingTree 6 | import dagger.hilt.android.HiltAndroidApp 7 | import timber.log.Timber 8 | import timber.log.Timber.DebugTree 9 | 10 | @HiltAndroidApp 11 | class AppTemplateApplication : Application() { 12 | 13 | override fun onCreate() { 14 | turnOnStrictMode() 15 | super.onCreate() 16 | 17 | plantTimber() 18 | } 19 | 20 | private fun plantTimber() { 21 | if (BuildConfig.DEBUG) { 22 | Timber.plant(DebugTree()) 23 | } else { 24 | Timber.plant(CrashReportingTree()) 25 | } 26 | } 27 | 28 | private fun turnOnStrictMode() { 29 | if (BuildConfig.DEBUG) { 30 | StrictMode.setThreadPolicy( 31 | StrictMode.ThreadPolicy.Builder() 32 | .detectAll() 33 | .penaltyLog() 34 | .build() 35 | ) 36 | StrictMode.setVmPolicy( 37 | StrictMode.VmPolicy.Builder() 38 | .detectActivityLeaks() 39 | .detectFileUriExposure() 40 | .detectLeakedClosableObjects() 41 | .detectLeakedRegistrationObjects() 42 | .detectLeakedSqlLiteObjects() 43 | .penaltyLog() 44 | .build() 45 | ) 46 | } 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Built application files 2 | *.apk 3 | *.aar 4 | *.ap_ 5 | *.aab 6 | 7 | # Files for the ART/Dalvik VM 8 | *.dex 9 | 10 | # Java class files 11 | *.class 12 | 13 | # Generated files 14 | bin/ 15 | gen/ 16 | out/ 17 | # Uncomment the following line in case you need and you don't have the release build type files in your app 18 | # release/ 19 | 20 | # Gradle files 21 | .gradle/ 22 | build/ 23 | 24 | # Local configuration file (sdk path, etc) 25 | local.properties 26 | 27 | # Proguard folder generated by Eclipse 28 | proguard/ 29 | 30 | # Log Files 31 | *.log 32 | 33 | # Android Studio Navigation editor temp files 34 | .navigation/ 35 | 36 | # Android Studio captures folder 37 | captures/ 38 | 39 | # IntelliJ 40 | *.iml 41 | .idea/ 42 | 43 | # Keystore files 44 | # Uncomment the following lines if you do not want to check your keystore files in. 45 | #*.jks 46 | #*.keystore 47 | 48 | # External native build folder generated in Android Studio 2.2 and later 49 | .externalNativeBuild 50 | .cxx/ 51 | 52 | # Google Services (e.g. APIs or Firebase) 53 | # google-services.json 54 | 55 | # Freeline 56 | freeline.py 57 | freeline/ 58 | freeline_project_description.json 59 | 60 | # fastlane 61 | fastlane/report.xml 62 | fastlane/Preview.html 63 | fastlane/screenshots 64 | fastlane/test_output 65 | fastlane/readme.md 66 | 67 | # Version control 68 | vcs.xml 69 | 70 | # lint 71 | lint/intermediates/ 72 | lint/generated/ 73 | lint/outputs/ 74 | lint/tmp/ 75 | # lint/reports/ 76 | 77 | # Android Profiling 78 | *.hprof -------------------------------------------------------------------------------- /app/src/main/java/com/stackinflow/androidapptemplate/ui/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.ui 2 | 3 | import android.os.Bundle 4 | import android.widget.Toast 5 | import androidx.activity.viewModels 6 | import androidx.appcompat.app.AppCompatActivity 7 | import androidx.compose.foundation.layout.Box 8 | import androidx.compose.foundation.layout.fillMaxHeight 9 | import androidx.compose.foundation.layout.fillMaxWidth 10 | import androidx.compose.material.Button 11 | import androidx.compose.material.Text 12 | import androidx.compose.ui.Alignment 13 | import androidx.compose.ui.Modifier 14 | import androidx.compose.ui.platform.setContent 15 | import dagger.hilt.android.AndroidEntryPoint 16 | 17 | @AndroidEntryPoint 18 | class MainActivity : AppCompatActivity() { 19 | 20 | private val viewModel: MainViewModel by viewModels() 21 | 22 | override fun onCreate(savedInstanceState: Bundle?) { 23 | super.onCreate(savedInstanceState) 24 | addObservers() 25 | 26 | setContentViewFromCompose() 27 | } 28 | 29 | private fun setContentViewFromCompose() { 30 | setContent { 31 | Box( 32 | modifier = Modifier.fillMaxHeight() 33 | .fillMaxWidth() 34 | ) { 35 | Button( 36 | onClick = { viewModel.getJokes() }, 37 | modifier = Modifier.align(Alignment.Center) 38 | ) { 39 | Text(text = "Get Data") 40 | } 41 | } 42 | } 43 | } 44 | 45 | private fun addObservers() { 46 | viewModel.viewState.observe( 47 | this, 48 | { 49 | Toast.makeText(this, "$it", Toast.LENGTH_SHORT) 50 | .show() 51 | } 52 | ) 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | AndroidAppTemplate 3 |

4 | 5 | # AndroidAppTemplate 6 | ###### All must have libraries in android app are available in here. you can get started with directly writing features with this. 7 | 8 | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/88d73da7cceb4164bec4295665b00924)](https://app.codacy.com/gh/stackinflow/AndroidAppTemplate?utm_source=github.com&utm_medium=referral&utm_content=stackinflow/AndroidAppTemplate&utm_campaign=Badge_Grade_Dashboard) 9 | [![stackinflow](https://img.shields.io/badge/stackinflow-opensource-brightgreen)](https://stackinflow.github.io/) 10 | [![CodeStyle](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/) 11 | [![CircleCI](https://circleci.com/gh/stackinflow/AndroidAppTemplate.svg?style=svg)](https://circleci.com/gh/stackinflow/androidapptemplate) [![Join the chat at https://gitter.im/stackinflow/AndroidAppTemplate](https://badges.gitter.im/stackinflow/AndroidAppTemplate.svg)](https://gitter.im/stackinflow/AndroidAppTemplate?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 12 | 13 | 14 | 15 | ## Includes 16 | - [kotlin](https://kotlinlang.org/) 17 | - [Jetpack Compose](https://developer.android.com/jetpack/compose) 18 | - [Architecture Components](https://developer.android.com/jetpack/guide) 19 | - [Dagger 🗡 hilt for dependency injection](https://dagger.dev/hilt/) 20 | - [Leak canary](https://square.github.io/leakcanary/) 21 | - [Timber](https://github.com/JakeWharton/timber) 22 | - [Retrofit](https://square.github.io/retrofit) 23 | - [Moshi](https://github.com/square/moshi) 24 | - Unit tests, instrumentation tests -------------------------------------------------------------------------------- /app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2.1 2 | 3 | config_android: &config_android 4 | working_directory: ~/AndroidAppTemplate 5 | docker: 6 | - image: circleci/android:api-29 7 | 8 | jobs: 9 | fastlane: 10 | <<: *config_android 11 | steps: 12 | - checkout 13 | - run: 14 | name: Fastlane update 15 | command: | 16 | bundle update fastlane 17 | - persist_to_workspace: 18 | root: . 19 | paths: . 20 | build: 21 | <<: *config_android 22 | steps: 23 | - attach_workspace: 24 | at: ~/AndroidAppTemplate 25 | - run: 26 | name: Build Debug APK 27 | command: | 28 | bundle install 29 | bundle exec fastlane build_debug 30 | - store_artifacts: 31 | path: app/build/outputs/apk/ 32 | destination: apks/ 33 | test: 34 | <<: *config_android 35 | steps: 36 | - attach_workspace: 37 | at: ~/AndroidAppTemplate 38 | - run: 39 | name: Run Tests 40 | command: | 41 | bundle install 42 | bundle exec fastlane test 43 | lint: 44 | <<: *config_android 45 | steps: 46 | - attach_workspace: 47 | at: ~/AndroidAppTemplate 48 | - run: 49 | name: Lint Check 50 | command: | 51 | bundle install 52 | bundle exec fastlane lint 53 | 54 | workflows: 55 | version: 2.1 56 | lint_build_test: 57 | jobs: 58 | - fastlane 59 | - lint: 60 | requires: 61 | - fastlane 62 | - test: 63 | requires: 64 | - fastlane 65 | - build: 66 | requires: 67 | - fastlane -------------------------------------------------------------------------------- /app/src/main/java/com/stackinflow/androidapptemplate/di/NetworkModule.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.di 2 | 3 | import android.content.Context 4 | import com.chuckerteam.chucker.api.ChuckerInterceptor 5 | import com.stackinflow.androidapptemplate.BuildConfig 6 | import com.stackinflow.androidapptemplate.network.api.JokeApiService 7 | import dagger.Module 8 | import dagger.Provides 9 | import dagger.hilt.InstallIn 10 | import dagger.hilt.android.qualifiers.ApplicationContext 11 | import dagger.hilt.components.SingletonComponent 12 | import okhttp3.OkHttpClient 13 | import okhttp3.logging.HttpLoggingInterceptor 14 | import retrofit2.Retrofit 15 | import retrofit2.converter.moshi.MoshiConverterFactory 16 | import java.util.concurrent.TimeUnit.SECONDS 17 | import javax.inject.Singleton 18 | 19 | @Module 20 | @InstallIn(SingletonComponent::class) 21 | object NetworkModule { 22 | 23 | private const val TIMEOUT_IN_SECONDS = 15L 24 | 25 | @Provides 26 | @Singleton 27 | fun provideOkHttpClient(@ApplicationContext context: Context): OkHttpClient { 28 | return OkHttpClient.Builder() 29 | .apply { 30 | if (BuildConfig.DEBUG) { 31 | addInterceptor( 32 | HttpLoggingInterceptor().apply { 33 | level = HttpLoggingInterceptor.Level.BODY 34 | } 35 | ) 36 | addInterceptor(ChuckerInterceptor(context)) 37 | } 38 | connectTimeout(TIMEOUT_IN_SECONDS, SECONDS) 39 | writeTimeout(TIMEOUT_IN_SECONDS, SECONDS) 40 | readTimeout(TIMEOUT_IN_SECONDS, SECONDS) 41 | } 42 | .build() 43 | } 44 | 45 | @Provides 46 | @Singleton 47 | fun provideRetrofit(okHttpClient: OkHttpClient): Retrofit { 48 | return Retrofit.Builder() 49 | .client(okHttpClient) 50 | .baseUrl(BuildConfig.BASE_URL) 51 | .addConverterFactory(MoshiConverterFactory.create()) 52 | .build() 53 | } 54 | 55 | @Provides 56 | @Singleton 57 | fun provideJokeApiService(retrofit: Retrofit): JokeApiService = 58 | retrofit.create(JokeApiService::class.java) 59 | } 60 | -------------------------------------------------------------------------------- /app/src/test/java/com/stackinflow/androidapptemplate/ui/MainViewModelTest.kt: -------------------------------------------------------------------------------- 1 | package com.stackinflow.androidapptemplate.ui 2 | 3 | import androidx.arch.core.executor.testing.InstantTaskExecutorRule 4 | import com.stackinflow.androidapptemplate.network.model.Joke 5 | import com.stackinflow.androidapptemplate.network.model.JokesResponse 6 | import com.stackinflow.androidapptemplate.repository.JokeRepo 7 | import com.stackinflow.androidapptemplate.util.TestCoroutineRule 8 | import com.stackinflow.androidapptemplate.util.getOrAwaitValue 9 | import io.mockk.MockKAnnotations 10 | import io.mockk.coEvery 11 | import io.mockk.impl.annotations.MockK 12 | import kotlinx.coroutines.ExperimentalCoroutinesApi 13 | import org.junit.After 14 | import org.junit.Assert.assertEquals 15 | import org.junit.Before 16 | import org.junit.Rule 17 | import org.junit.Test 18 | import retrofit2.Response 19 | 20 | class MainViewModelTest { 21 | 22 | /** 23 | * A JUnit Test Rule that swaps the background executor used by the Architecture Components 24 | * with a different one which executes each task synchronously. 25 | */ 26 | @get: Rule 27 | val instantTaskExecutorRule = InstantTaskExecutorRule() 28 | 29 | @MockK 30 | lateinit var jokeRepo: JokeRepo 31 | 32 | @ExperimentalCoroutinesApi 33 | @get:Rule 34 | val testCoroutineRule = TestCoroutineRule() 35 | 36 | @Before 37 | fun setUp() { 38 | MockKAnnotations.init(this) 39 | } 40 | 41 | @After 42 | fun tearDown() { 43 | } 44 | 45 | @Test 46 | fun getJokesList_successResponse_updatesLiveData() { 47 | // Given a fresh MainViewModel 48 | coEvery { jokeRepo.getJokes() } returns Response.success( 49 | getJokeSuccessDummyData() 50 | ) 51 | val viewModel = MainViewModel(jokeRepo) 52 | 53 | // When called getJokes 54 | viewModel.getJokes() 55 | 56 | // Then the liveData should update with mock data 57 | assertEquals( 58 | viewModel.viewState.getOrAwaitValue(), ViewState.Success(getJokeSuccessDummyData()) 59 | ) 60 | } 61 | 62 | private fun getJokeSuccessDummyData(): JokesResponse { 63 | return JokesResponse( 64 | "success", 65 | listOf(Joke(1, "joke", listOf("boo"))) 66 | ) 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'kotlin-android' 4 | id 'kotlin-kapt' 5 | id 'dagger.hilt.android.plugin' 6 | } 7 | 8 | import com.stackinflow.androidapptemplate.buildsrc.AppConfig 9 | import com.stackinflow.androidapptemplate.buildsrc.Lib 10 | 11 | android { 12 | compileSdkVersion AppConfig.COMPILE_SDK 13 | 14 | defaultConfig { 15 | applicationId AppConfig.APP_ID 16 | minSdkVersion AppConfig.MIN_SDK 17 | targetSdkVersion AppConfig.TARGET_SDK 18 | versionCode AppConfig.VERSION_CODE 19 | versionName AppConfig.VERSION_NAME 20 | 21 | testInstrumentationRunner "com.stackinflow.androidapptemplate.CustomTestRunner" 22 | 23 | buildConfigField( 24 | "String", 25 | "BASE_URL", 26 | "\"https://api.icndb.com\"" 27 | ) 28 | } 29 | 30 | buildTypes { 31 | release { 32 | minifyEnabled true 33 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 34 | } 35 | } 36 | 37 | compileOptions { 38 | sourceCompatibility JavaVersion.VERSION_11 39 | targetCompatibility JavaVersion.VERSION_11 40 | } 41 | 42 | kotlinOptions { 43 | jvmTarget = '11' 44 | useIR = true 45 | } 46 | 47 | composeOptions { 48 | kotlinCompilerVersion '1.4.20' 49 | kotlinCompilerExtensionVersion '1.0.0-alpha08' 50 | } 51 | 52 | testOptions { 53 | unitTests { 54 | includeAndroidResources = true 55 | } 56 | } 57 | buildFeatures { 58 | compose true 59 | } 60 | } 61 | 62 | hilt { 63 | enableTransformForLocalTests = true 64 | } 65 | 66 | kapt { 67 | correctErrorTypes true 68 | } 69 | 70 | dependencies { 71 | 72 | implementation Lib.Androidx.ACTIVITY_KTX 73 | implementation Lib.Androidx.APP_COMPAT 74 | implementation Lib.Androidx.CORE_KTX 75 | implementation Lib.Androidx.CONSTRAINT_LAYOUT 76 | implementation Lib.Androidx.LIFECYCLE_VIEWMODEL 77 | androidTestImplementation Lib.Androidx.Test.ESPRESSO_CORE 78 | androidTestImplementation Lib.Androidx.Test.EXT_JUNIT 79 | 80 | implementation Lib.Androidx.Compose.UI 81 | implementation Lib.Androidx.Compose.MATERIAL 82 | implementation Lib.Androidx.Compose.TOOLING 83 | androidTestImplementation Lib.Androidx.Compose.TESTING 84 | 85 | implementation Lib.Androidx.Hilt.LIFECYCLE_VIEWMODEL 86 | implementation Lib.Androidx.Hilt.WORK 87 | kapt Lib.Androidx.Hilt.COMPILER 88 | kaptTest Lib.Androidx.Hilt.COMPILER 89 | kaptAndroidTest Lib.Androidx.Hilt.COMPILER 90 | 91 | debugImplementation Lib.Chucker.CHUCKER_DEBUG 92 | releaseImplementation Lib.Chucker.CHUCKER_NO_OP_RELEASE 93 | 94 | implementation Lib.Google.Dagger.HILT_ANDROID 95 | kapt Lib.Google.Dagger.HILT_ANDROID_COMPILER 96 | implementation Lib.Google.MATERIAL_DESIGN 97 | 98 | androidTestImplementation Lib.Google.Dagger.Test.HILT_ANDROID_TESTING 99 | kaptAndroidTest Lib.Google.Dagger.HILT_ANDROID_COMPILER 100 | 101 | testImplementation Lib.Google.Dagger.Test.HILT_ANDROID_TESTING 102 | kaptTest Lib.Google.Dagger.HILT_ANDROID_COMPILER 103 | 104 | implementation Lib.Kotlin.STD_LIB 105 | implementation Lib.Kotlin.COROUTINES 106 | implementation Lib.Kotlin.COROUTINES_ANDROID 107 | testImplementation Lib.Kotlin.COROUTINES_TEST 108 | testImplementation Lib.Kotlin.COROUTINES 109 | 110 | implementation Lib.Logger.TIMBER 111 | 112 | implementation Lib.Square.LOGGING_INTERCEPTOR 113 | implementation Lib.Square.RETROFIT 114 | implementation Lib.Square.RETROFIT_MOSHI 115 | 116 | debugImplementation Lib.Square.LEAK_CANARY 117 | 118 | testImplementation Lib.Test.ARCH_CORE 119 | testImplementation Lib.Test.CORE_TEST 120 | testImplementation Lib.Test.JUNIT 121 | testImplementation Lib.Test.ROBOELECTRIC 122 | 123 | testImplementation Lib.Test.MOCK.MOCKK 124 | androidTestImplementation Lib.Test.MOCK.ANDROID_MOCKK 125 | testImplementation Lib.Test.MOCK.MOCK_WEB_SERVER 126 | } -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | GEM 2 | remote: https://rubygems.org/ 3 | specs: 4 | CFPropertyList (3.0.2) 5 | addressable (2.7.0) 6 | public_suffix (>= 2.0.2, < 5.0) 7 | atomos (0.1.3) 8 | aws-eventstream (1.1.0) 9 | aws-partitions (1.345.0) 10 | aws-sdk-core (3.104.3) 11 | aws-eventstream (~> 1, >= 1.0.2) 12 | aws-partitions (~> 1, >= 1.239.0) 13 | aws-sigv4 (~> 1.1) 14 | jmespath (~> 1.0) 15 | aws-sdk-kms (1.36.0) 16 | aws-sdk-core (~> 3, >= 3.99.0) 17 | aws-sigv4 (~> 1.1) 18 | aws-sdk-s3 (1.75.0) 19 | aws-sdk-core (~> 3, >= 3.104.1) 20 | aws-sdk-kms (~> 1) 21 | aws-sigv4 (~> 1.1) 22 | aws-sigv4 (1.2.1) 23 | aws-eventstream (~> 1, >= 1.0.2) 24 | babosa (1.0.3) 25 | claide (1.0.3) 26 | colored (1.2) 27 | colored2 (3.1.2) 28 | commander-fastlane (4.4.6) 29 | highline (~> 1.7.2) 30 | declarative (0.0.20) 31 | declarative-option (0.1.0) 32 | digest-crc (0.6.1) 33 | rake (~> 13.0) 34 | domain_name (0.5.20190701) 35 | unf (>= 0.0.5, < 1.0.0) 36 | dotenv (2.7.6) 37 | emoji_regex (3.0.0) 38 | excon (0.75.0) 39 | faraday (1.0.1) 40 | multipart-post (>= 1.2, < 3) 41 | faraday-cookie_jar (0.0.6) 42 | faraday (>= 0.7.4) 43 | http-cookie (~> 1.0.0) 44 | faraday_middleware (1.0.0) 45 | faraday (~> 1.0) 46 | fastimage (2.1.7) 47 | fastlane (2.153.1) 48 | CFPropertyList (>= 2.3, < 4.0.0) 49 | addressable (>= 2.3, < 3.0.0) 50 | aws-sdk-s3 (~> 1.0) 51 | babosa (>= 1.0.3, < 2.0.0) 52 | bundler (>= 1.12.0, < 3.0.0) 53 | colored 54 | commander-fastlane (>= 4.4.6, < 5.0.0) 55 | dotenv (>= 2.1.1, < 3.0.0) 56 | emoji_regex (>= 0.1, < 4.0) 57 | excon (>= 0.71.0, < 1.0.0) 58 | faraday (~> 1.0) 59 | faraday-cookie_jar (~> 0.0.6) 60 | faraday_middleware (~> 1.0) 61 | fastimage (>= 2.1.0, < 3.0.0) 62 | gh_inspector (>= 1.1.2, < 2.0.0) 63 | google-api-client (>= 0.37.0, < 0.39.0) 64 | google-cloud-storage (>= 1.15.0, < 2.0.0) 65 | highline (>= 1.7.2, < 2.0.0) 66 | json (< 3.0.0) 67 | jwt (>= 2.1.0, < 3) 68 | mini_magick (>= 4.9.4, < 5.0.0) 69 | multipart-post (~> 2.0.0) 70 | plist (>= 3.1.0, < 4.0.0) 71 | rubyzip (>= 2.0.0, < 3.0.0) 72 | security (= 0.1.3) 73 | simctl (~> 1.6.3) 74 | slack-notifier (>= 2.0.0, < 3.0.0) 75 | terminal-notifier (>= 2.0.0, < 3.0.0) 76 | terminal-table (>= 1.4.5, < 2.0.0) 77 | tty-screen (>= 0.6.3, < 1.0.0) 78 | tty-spinner (>= 0.8.0, < 1.0.0) 79 | word_wrap (~> 1.0.0) 80 | xcodeproj (>= 1.13.0, < 2.0.0) 81 | xcpretty (~> 0.3.0) 82 | xcpretty-travis-formatter (>= 0.0.3) 83 | gh_inspector (1.1.3) 84 | google-api-client (0.38.0) 85 | addressable (~> 2.5, >= 2.5.1) 86 | googleauth (~> 0.9) 87 | httpclient (>= 2.8.1, < 3.0) 88 | mini_mime (~> 1.0) 89 | representable (~> 3.0) 90 | retriable (>= 2.0, < 4.0) 91 | signet (~> 0.12) 92 | google-cloud-core (1.5.0) 93 | google-cloud-env (~> 1.0) 94 | google-cloud-errors (~> 1.0) 95 | google-cloud-env (1.3.3) 96 | faraday (>= 0.17.3, < 2.0) 97 | google-cloud-errors (1.0.1) 98 | google-cloud-storage (1.26.2) 99 | addressable (~> 2.5) 100 | digest-crc (~> 0.4) 101 | google-api-client (~> 0.33) 102 | google-cloud-core (~> 1.2) 103 | googleauth (~> 0.9) 104 | mini_mime (~> 1.0) 105 | googleauth (0.13.0) 106 | faraday (>= 0.17.3, < 2.0) 107 | jwt (>= 1.4, < 3.0) 108 | memoist (~> 0.16) 109 | multi_json (~> 1.11) 110 | os (>= 0.9, < 2.0) 111 | signet (~> 0.14) 112 | highline (1.7.10) 113 | http-cookie (1.0.3) 114 | domain_name (~> 0.5) 115 | httpclient (2.8.3) 116 | jmespath (1.4.0) 117 | json (2.3.1) 118 | jwt (2.2.1) 119 | memoist (0.16.2) 120 | mini_magick (4.10.1) 121 | mini_mime (1.0.2) 122 | multi_json (1.15.0) 123 | multipart-post (2.0.0) 124 | nanaimo (0.3.0) 125 | naturally (2.2.0) 126 | os (1.1.0) 127 | plist (3.5.0) 128 | public_suffix (4.0.5) 129 | rake (13.0.1) 130 | representable (3.0.4) 131 | declarative (< 0.1.0) 132 | declarative-option (< 0.2.0) 133 | uber (< 0.2.0) 134 | retriable (3.1.2) 135 | rouge (2.0.7) 136 | rubyzip (2.3.0) 137 | security (0.1.3) 138 | signet (0.14.0) 139 | addressable (~> 2.3) 140 | faraday (>= 0.17.3, < 2.0) 141 | jwt (>= 1.5, < 3.0) 142 | multi_json (~> 1.10) 143 | simctl (1.6.8) 144 | CFPropertyList 145 | naturally 146 | slack-notifier (2.3.2) 147 | terminal-notifier (2.0.0) 148 | terminal-table (1.8.0) 149 | unicode-display_width (~> 1.1, >= 1.1.1) 150 | tty-cursor (0.7.1) 151 | tty-screen (0.8.1) 152 | tty-spinner (0.9.3) 153 | tty-cursor (~> 0.7) 154 | uber (0.1.0) 155 | unf (0.1.4) 156 | unf_ext 157 | unf_ext (0.0.7.7) 158 | unicode-display_width (1.7.0) 159 | word_wrap (1.0.0) 160 | xcodeproj (1.17.1) 161 | CFPropertyList (>= 2.3.3, < 4.0) 162 | atomos (~> 0.1.3) 163 | claide (>= 1.0.2, < 2.0) 164 | colored2 (~> 3.1) 165 | nanaimo (~> 0.3.0) 166 | xcpretty (0.3.0) 167 | rouge (~> 2.0.7) 168 | xcpretty-travis-formatter (1.0.0) 169 | xcpretty (~> 0.2, >= 0.0.7) 170 | 171 | PLATFORMS 172 | ruby 173 | 174 | DEPENDENCIES 175 | fastlane 176 | 177 | BUNDLED WITH 178 | 1.17.2 179 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 12 | 17 | 24 | 398 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------