iamsafidev / teanity

Android-Kotlin "framework" designed to reduce boilerplate.

Central backbone of your project. Why choose teanity?

• Modular: You're in power of what modules will be present in your next project. Why include the entire library? Mix and match what you need.
• Light: Although it has big ideas, it only adds ~500 methods on top of included libraries.
• Dependable: Fortified for exceptions of all kinds.
• Proven: It's already used and deployed in real projects.

Functionality

Teanity provides wide variety of helpers, tools and architectural proposition. It heavily relies on Coroutines and Android's Lifecycle libraries. All tools are oriented that way, however it doesn't discriminate against one tool or another. Use what feels best for you.

Read additional info for all modules:

• Components module
• Core module
• DI module
• Network module
• Persistence module
• UI module

Where to start?

Plugin (recommended)

Include our plugin in your project: $projectRoot/build.gradle

buildscript {
    repositories {
        //...
        maven { url 'https://jitpack.io' }
    }

    dependencies {
        classpath("com.skoumal:teanity-plugin:+")
    }
}

allprojects {
    repositories {
        //...
        maven { url 'https://jitpack.io' }
    }
}

Set up on per-module basis: $projectRoot/module/build.gradle

plugins {
    id("com.android.application") // or com.android.library
    // kotlin (-android-extensions and -kapt) will be added for you
    id("teanity")
}

teanity {
    modules {
        useAll()
    }
}

Manual dep

Include dependencies manually: $projectRoot/module/build.gradle

dependencies {
    def vTeanity = "1.+" // todo replace with specific version
    implementation("com.skoumal.teanity:core:$vTeanity")
    implementation("com.skoumal.teanity:di:$vTeanity")
    implementation("com.skoumal.teanity:network:$vTeanity")
    implementation("com.skoumal.teanity:persistence:$vTeanity")
    implementation("com.skoumal.teanity:ui:$vTeanity")

    androidTestImplementation("com.skoumal.teanity:test-ui:$vTeanity")
    testImplementation("com.skoumal.teanity:test:$vTeanity")
}