README.md

Stackbricks

引入项目

添加Github Packages源

Note

建议遵循Github官方文档进行部署。

• 在项目根目录的setting.gradle文件中添加如下内容：

dependencyResolutionManagement {
    repositories {
        maven {
            url = uri("https://maven.pkg.github.com/aquamarine5/Stackbricks")
            credentials {
                username = project.findProperty("gpr.user") ?: System.getenv("GPR_USERNAME")
                password = project.findProperty("gpr.key") ?: System.getenv("GPR_TOKEN")
            }
        }
    }
}

Warning

请确保gpr.user和gpr.key的值已经在gradle.properties配置，或通过环境变量配置。

添加依赖

dependencies {
    implementation 'org.aquamarine5.brainspark:stackbricks:$latest_version'
}

• 最新版本可以在Github Packages源查询。

使用Gradle插件

• 使用stackbricks-gradle-plugin来一键式设置Stackbricks在服务器上的配置。

plugins {
    id "org.aquamarine5.brainspark.stackbricks-gradle-plugin" version "$latest_sgp_version"
}

Warning

$latest_sgp_version和$latest_version并不同步。

使用

对于Jetpack Compose

val service = StackbricksService(
    LocalContext.current,
    messageProvider = TODO(),
    packageProvider = TODO(),
    rememberStackbricksStatus(),
    buildConfig = ApplicationBuildConfig(
        versionName = BuildConfig.VERSION_NAME,
        isAllowedToDisableCheckUpdateOnLaunch = false
    )
)
StackbricksComponent(
    service,
    modifier = Modifier,
    trigger = object : StackbricksEventTrigger() {
        override fun onChannelChanged(isTestChannel: Boolean) { }

        override fun onCheckUpdate(isTestChannel: Boolean) { }

        override fun onCheckUpdateOnLaunchChanged(isChecked: Boolean) { }

        override fun onDownloadPackage() { }

        override fun onInstallPackage(isTestChannel: Boolean, versionData: StackbricksVersionData) { }
    }
)

Providers

Qiniu（七牛云）

val qiniuConfiguration = QiniuConfiguration("Your Qiniu CDN Host without http/https")
val messageProvider = QiniuMessageProvider(qiniuConfiguration)
val packageProvider = QiniuPackageProvider(qiniuConfiguration)