Skip to content

Adding Dependencies

AmirHossein Abdolmotallebi edited this page Apr 28, 2023 · 1 revision

Add repository

first of all make sure you declared jitpack repository

//build.gradle.kts
repositories {
    //...
    maven("https://jitpack.io")
}

Then add core and backend dependencies

//build.gradle.kts

dependencies {
    //...
    val version = "x.y.z" //see the last version above
    //core library
    debugImplementation("com.github.amir1376.debugboard:core:$version")
    releaseImplementation("com.github.amir1376.debugboard:core-no-op:$version")
    
    //backend for panel (Web / IntelliJ Plugin)
    debugImplementation("com.github.amir1376.debugboard:backend:$version")
    releaseImplementation("com.github.amir1376.debugboard:backend-no-op:$version")
}
that two modules are enough for a basic usage
but these are also optional dependencies which you may want to use
```kotlin
    //optional integrations
    //add one of these integrations for network inspection
    debugImplementation("com.github.amir1376.debugboard:ktor:$version")
    releaseImplementation("com.github.amir1376.debugboard:ktor-no-op:$version")
    debugImplementation("com.github.amir1376.debugboard:okhttp:$version")
    releaseImplementation("com.github.amir1376.debugboard:okhttp-no-op:$version")

    // integration for android timber library
    debugImplementation("com.github.amir1376.debugboard:timber:$version")
    releaseImplementation("com.github.amir1376.debugboard:timber-no-op:$version")

    // integration for jetpack compose library 
    debugImplementation("com.github.amir1376.debugboard:compose:$version")
    releaseImplementation("com.github.amir1376.debugboard:compose-no-op:$version")

What is that no-op postfix after module names?

It is the "No Operation" version of that module. It removes all functionalities that DebugBoard uses during development which reduces release output size You can use it in your release variants

Clone this wiki locally