快速入門

添加依賴

此函式庫是透過 Maven 進行封裝，並上傳至 GitHub Package 的方式

引入方式

【GitHub】

• 建立 Personal Access Token

  • 於個人 GitHub Settings -> Developer Settings -> Personal access tokens -> Tokens (classic)
  • 新增一個新的 Token

    • 點擊 Generate new token (classic) 新增 Token

    • 輸入 Note

      隨意輸入，比如輸入此 Token 為甚麼用途之類的

    • 權限設置

      僅需勾選 read:packages 即可儲存

【Android Studio】

• 建立 keysotre.properties

  • 於專案根目錄新增 keysotre.properties 檔案

    建議將此檔案加入 .gitignore

  • 於檔案中加上以下內容（無需將字串加上雙引號）

    gpr.usr={{GitHub User ID}}
    gpr.key={{GitHub Personal Access Token}}

• 設置欲引入的目的地與 Authentication

  • setting.gradle - Groovy

    def keystoreProperties = new Properties()
    file("keystore.properties").withInputStream {
        keystoreProperties.load(it)
    }
     
    dependencyResolutionManagement {
        repositories {
          maven {
              url = uri("https://maven.pkg.github.com/farmlandtech/AndroidBikeKitPublic")
        
              credentials {
                  username = keystoreProperties["gpr.usr"]
                  password = keystoreProperties["gpr.key"]
              }
          }
        }
    }

  • setting.gradle.kts - Kotlin DSL

    // 獲取 keystore.properties
    val keystoreProperties = java.util.Properties()
    keystoreProperties.load(java.io.FileInputStream(File("keystore.properties")))
     
    dependencyResolutionManagement {
        repositories {
            google()
            mavenCentral()
            maven { url = uri("https://jitpack.io") }
            maven {
                url = uri("https://maven.pkg.github.com/farmlandtech/AndroidBikeKitPublic")
                credentials {
                    username = keystoreProperties.getProperty("gpr.usr")
                    password = keystoreProperties.getProperty("gpr.key")
                }
            }
        }
    }

• 引入 BikeKit

  • build.gradle(:app) - Groovy

  dependencies {
    implementation 'com.github.farmlandtech:android-bikekit-public:{{release_version}}'
  }
  • build.gradle.kts(:app) - Kotlin

  dependencies {
    implementation("com.github.farmlandtech:android-bikekit-public:{{release_version}}")
  }

• 進行 Gradle Sync，確認有引入成功後，即可開始使用