Skip to content

ivzb/github_browser

Repository files navigation

GitHub Browser

Features

Simple GitHub user and repository browser.

The application is able to search for users and show their repositories with additional information.

After login, the user is landed on the user screen.

The user screen has avatar, username, number of followers and the number of people the user is following.

List of the user's and starred repositories.

The "Followers" and "Following" are clickable and when clicked on, open a list of corresponding users.

A search icon, on which when clicked, a user may filter the results.

When clicked on any repository item on the list, a repository screen opens.

It has contributors and owner button which navigate to appropriate screens.

Star/Unstar functionality is also included.

There is also bottom menu with "Home", "Search" and "Logout" items.

All data is cached on the device for offline access.

Screenshots

Login & GitHub oauth

Login Login oauth

Home & User profile

Home User profile

User own & starred repositories

User own repos User starred repos

User followers & following

User followers User following

Repository profile & contributors

Repository profile Repository contributors

Search & Search types

Search Search type

Search repositories & users

Search repositories Search users

Development Environment

The app is written entirely in Kotlin and uses the Gradle build system.

To build the app, use the gradlew build command or use "Import Project" in Android Studio. MinSdkVersion is 28.

Architecture

The architecture is built around Android Architecture Components.

Followed the recommendations laid out in the Guide to App Architecture when deciding on the architecture for the app. Logic is kept away from Activities and Fragments and moved to ViewModels. Observed data using LiveData and Data Binding Library to bind UI components in layouts to the app's data sources. Room is used for offline storage.

Repository layer is used for handling data operations. Data comes from a GitHub API and is fetched on the go. The repository modules are responsible for handling all data operations and abstracting the data sources from the rest of the app. (if we wanted to swap the API for a different data source in the future,
the architecture allows to do so in a clean way).

Implemented a lightweight domain layer, which sits between the data layer and the presentation layer, and handles discrete pieces of business logic off the UI thread. See the UseCase.kt files under /domain for examples.

Used Navigation component to simplify into a single Activity app.

Used Dagger2 for dependency injection and heavily relied on dagger-android to abstract away boiler-plate code.

About

Simple GitHub user and repository browser.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages