Skip to content

syslogic/androidx-github

Repository files navigation

androidx-github

This is an unofficial Android client for GitHub API, which utilizes the AndroidX & Retrofit2 libraries.

  • by default, one can browse the own repositories and workflows.
  • by default, one can browse Android/Kotlin/Gradle projects, but it features an editor for bookmarks.
  • it generally supports git operations (check out only, so far), see jgit.

Debug Builds

File token.properties may be created with a GitHub access token declared as accessToken=ghp_....
Without an access token the API will be "rate limited", after having loaded the first 10 pages in quick succession. When file token.properties is absent (or in release builds), the access token still can be added in the preferences.

Security

Only GitHub traffic is being permitted, see network_security_config.xml.

Screenshots

Repositories
Workflow Steps


Android Library

The :library module is available on JitPack; either by version tag or master-SNAPSHOT.
It provides the relevant GitHub API calls & data-models with data-binding annotations.
The JitPack repository URL would be: maven { url 'https://jitpack.io' }

dependencies {
    // implementation "io.syslogic:androidx-github:master-SNAPSHOT"
    implementation "io.syslogic:androidx-github:1.1.9"
}

Release MIT License