icodein / jethub

Sample App with Jetpack components(LiveData, Navigation, ViewModel) + MVVM + coroutine + single activity

Android Sample App using Github API and Jetpack Component.

What's JetHub? 🚀

JetHub is a sample app using Github API and Jetpack components.

The purpose of this project is to try new Android technologies and learn how it works in an app.

Used Libraries

• Navigation (Fragment transitions)
• View Binding (Bind views)
• ViewModel (Store and manage UI-related data)
• LiveData (Observable data)
• Jetpack Compose (Declarative UI)
• Kotlin Coroutine (Light-weight threads)
• Dagger2 (Dependency Injection)
• Hilt (Dependency Injection for Android)
• Room (Abstraction layer over SQLite)
• Retrofit (HTTP client)
• Mockk (Unit testing)

Multi Module / Dynamic Feature Module

This projects consists of multiple modules and some of them are provided as Dynamic Feature Module.

Feature Module

:feed, :search, :pin are feature modules. These are included in base.apk and does not require user to download one later.

Dynamic Feature Module

:repo, :developer are dynamic feature modules. These are not included in base.apk and require user to download one on demand. The details can be learned from here.

Architecture

This app uses MVVM architecture and follows the guildline shown here.

This is also a single-activity application. All screen transitions are done by Navigation.

//--- Activity / Fragments ---//

viewModel.data.observe(this) { data ->
    // do fun things
}) 

//--- ViewModel ---//

val data: LiveData<Data>
repository.getData() // get data from API and/or DB

//--- Repository ---//

api.getData() // get data from API
db.getData() // get data from DB

🚧 Jetpack Compose (Under Development) 🚧

Jetpack Compose is used for the screens of :repo, :developer modules. Therefore, To build this project, you will need the latest canary version of Android Studio Preview. I'm currently migrating to Jetpack Compose and the design is in progress for now.

Dark Theme

Dark Theme is supported. You can toggle theme by tapping the theme icon on top right corner. The selected theme would be retained in application scope for the sake of demo application.

Github API Token

This project is based on GitHub API. You can set your own token in local.properties and JetHub will use the token for every single request to Github.

If you do not have a GitHub token, that's fine. You can use this app without a token, but the number of API call is very limited by Github. You can see the details from this link.

// local.properties
api_token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Author

• Taku Semba
  • Github - (https://github.com/takusemba)
  • Twitter - (https://twitter.com/takusemba)
  • Facebook - (https://www.facebook.com/takusemba)

Licence

Copyright 2017 Taku Semba.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.