/SDKCreationExampleApp

This is the sample app for how to create the SDK file and use in Android app. Used Java, retrofit2, okhttp3 and Gson to develop this AAR.

Primary LanguageJava

AAR file / gitrepositorylib module usage.

Add the gitrepositorylib_aar_file/gitrepositorylib.aar file to libs folder of the application project. Include below dependencies.

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.aar'])
    ......
}

OR one more way is, implement gitrepositorylib module in dependencies.

dependencies {
    implementation project(path: ':gitrepositorylib')
    ......
}

build.gradle dependencies.

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.aar'])

    implementation 'androidx.appcompat:appcompat:1.1.0'
    implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
    // Gson
    implementation 'com.google.code.gson:gson:2.8.6'
    // Retrifit
    implementation 'com.squareup.retrofit2:retrofit:2.6.2'
    implementation 'com.squareup.retrofit2:converter-gson:2.6.2'
    // OKHttp
    implementation 'com.squareup.okhttp3:logging-interceptor:4.2.2'
    implementation 'com.squareup.okhttp3:okhttp:4.2.2'
}

Permission in AndroidManifest.xml.

Below permission is required to make a repository call.

<uses-permission android:name="android.permission.INTERNET" />

Usage

  • To get the GitHub repository information "items" list in that item object contains name, privacy status, description and language info.
  • Need to call GithubRepositorySDK.getRepositoryInfo(platform, organization) in background thread by passing Two parameters.
  • First parameter represents the platform info e.g. android, ios, etc...
  • Second parameter represents the organization info e.g. orgA, orgB, etc...