Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

GitHub Profile Finder (Kotlin + Jetpack Compose)

An Android app that looks up any GitHub username and displays their profile in a GitHub-style dark UI: avatar, bio, company/location/blog, follower and repo counts, and a scrollable list of their public repositories (with language color dot, stars, and forks).

Tech stack

  • Kotlin + Jetpack Compose (Material 3)
  • Retrofit + Gson — talks to the public GitHub REST API (api.github.com)
  • Coil — avatar image loading
  • MVVM (GitHubViewModel + sealed UiState)

How to run

  1. Open this folder in Android Studio (Koala/2024.1 or newer recommended).
  2. Let Gradle sync (it will download dependencies — needs internet).
  3. Run on an emulator or device (minSdk 24 / Android 7.0+).
  4. Type any GitHub username (e.g. torvalds, octocat, google) and tap Go or hit search on the keyboard.

Notes

  • Uses the unauthenticated GitHub API, which is rate-limited to 60 requests/hour per IP. If you hit the limit, wait an hour or add a personal access token to the Retrofit client's OkHttpClient as an Authorization: Bearer <token> header.
  • Tapping "View on GitHub" or a repo card opens that page in the browser.
  • No external API key or backend server is required.

Project structure

app/src/main/java/com/example/githubfinder/
├── MainActivity.kt        # Compose UI (GitHub-style dark theme)
├── GitHubViewModel.kt      # State handling: Idle / Loading / Success / Error
├── GitHubApiService.kt     # Retrofit interface + client
└── GitHubUser.kt           # Data models (GitHubUser, GitHubRepo)

Customizing

  • Colors live in MainActivity.kt under the GhColors object — tweak these to change the theme.
  • To show more/fewer repos, change perPage in GitHubApiService.getRepos.
  • To add authenticated requests (higher rate limit), add a token header in RetrofitInstance's OkHttpClient.Builder().

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages