GithubApp 📱
An Android application to fetch and search the repositories from the Github REST API. App is built with modern Android components using MVVM architecture.
Features
- View Repositories
- Search Repositories
- Swipe to Refresh
- Loading/Error State
- Offline Caching
- Paging
Built with ⚙️
Working
Application has two screens, Home and Search Fragment. Home and Search Functionality can also be implemented in one screen, they are separated to demonstrate the Navigation and UI State Handling. Hilt is used to provide dependencies.
- Home Fragment
This shows the list of repo, For demonstration repositories of square was used, the endpoint can be modified. Data handling would remain same. Paging is included in this Fragment. The API response is made and the response is cached. The data is served from the Room Database. Loading and Error state is shown accordingly.
- Search Fragment
This fragment has a search view, it fetches the repositories from the database on query submit
Data Layer
Data
|_ Room Database
|
|_ Remote API
- Database serves as single source of truth. The data is fetched from the Github REST API and stored in the Room Database
- Remote API. There are two API endpoints, one for repository and another for querying.
- View Repository -> The network call is made and data is cached in the database. This returns the repository for a user, currently used Square for demonstration purpose. This can be modified for other use cases. Data handling would be the same
- Query Repository -> This is implemented using both database to fetch from the storage and API. This query finds the repository and finds the particular repo in the database. Also Implemented the repo fetch from the API.
- Paging3 handles the Home Fragment's data.
UI
Jetpack Navigation is used for the fragment navigation and Data for the home fragment is produced by the PagingSource