Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TakuSemba/JetHub
Sample App with Jetpack components(LiveData, Navigation, ViewModel) + MVVM + coroutine + single activity
https://github.com/TakuSemba/JetHub
android coroutines jetpack jetpack-compose livedata mvvm navigation sample viewmodel
Last synced: 3 months ago
JSON representation
Sample App with Jetpack components(LiveData, Navigation, ViewModel) + MVVM + coroutine + single activity
- Host: GitHub
- URL: https://github.com/TakuSemba/JetHub
- Owner: TakuSemba
- License: apache-2.0
- Created: 2018-12-27T07:12:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-14T11:11:29.000Z (almost 2 years ago)
- Last Synced: 2024-06-20T06:47:07.161Z (5 months ago)
- Topics: android, coroutines, jetpack, jetpack-compose, livedata, mvvm, navigation, sample, viewmodel
- Language: Kotlin
- Homepage:
- Size: 3.71 MB
- Stars: 436
- Watchers: 13
- Forks: 53
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-compose - JetHub - JetHub is a sample app using Github API and Jetpack components (Miscellaneous)
README
Android Sample App using Github API and Jetpack Component.
## What's JetHub? :rocket:
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
- [Jetpack Compose](https://developer.android.com/jetpack/compose) (Decleartive UI)
- [Navigation](https://developer.android.com/topic/libraries/architecture/navigation) (Fragment transitions)
- [View Binding](https://developer.android.com/topic/libraries/view-binding) (Bind views)
- [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) (Store and manage UI-related data)
- [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) (Observable data)
- [Jetpack Compose](https://developer.android.com/jetpack/compose) (Declarative UI)
- [Kotlin Coroutine](https://github.com/Kotlin/kotlinx.coroutines) (Light-weight threads)
- [Dagger2](https://github.com/google/dagger) (Dependency Injection)
- [Hilt](https://dagger.dev/hilt/) (Dependency Injection for Android)
- [Room](https://developer.android.com/topic/libraries/architecture/room) (Abstraction layer over SQLite)
- [Retrofit](https://github.com/square/retrofit) (HTTP client)
- [Mockk](https://github.com/mockk/mockk) (Unit testing)
## Multi Module / Dynamic Feature Module
This project 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](https://developer.android.com/guide/app-bundle/dynamic-delivery). These are not included in base.apk and require user to download one on demand.
## Architecture
This app is a single-activity application and uses MVVM architecture and follows the guildline shown [here](https://developer.android.com/jetpack/docs/guide).
```kt
//--- Activity / Fragments / Compose ---//
lifecycleScope.launch {
viewModel.uiState
.flowWithLifecycle(lifecycle, Lifecycle.State.STARTED)
.collect { data -> /* do something */ }
}
val uiState by repoViewModel.uiState.collectAsState()
//--- ViewModel ---//
val uiState: StateFlow
repository.getData() // get data from API and/or DB
//--- Repository ---//
api.getData() // get data from API
db.getData() // get data from DB
```
## Dark Theme
Dark Theme is supported. You can toggle theme by tapping the theme icon on the 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.
In order to generate a token, you can do so from [your settings page](https://github.com/settings/tokens).
This app works without a token, but the number of API call is very limited by Github. You can see the details from this [link](https://developer.github.com/v3/#rate-limiting).
```local.properties
// 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.
```