Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
raheemadamboev authored Aug 29, 2022
1 parent 71e7534 commit d8ba98b
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<h1 align="center">Kichkina Shahzoda</h1>

<p align="center">
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
<a href="https://android-arsenal.com/api?level=21"><img alt="API" src="https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=flat"/></a>
</p>

<p align="center">
🎵 "Kichkina Shahzoda" app demonstrates modern Android app development with Jetpack Compose, Hilt, Material3, Coroutines, Flows, ExoPlayer2 based on MVVM architecture. It plays "Kichkina Shahzoda" audio-book locally without internet.
</p>
</br>

<p align="center">
<img src="/Kichkina%20Shahzoda.jpg"/>
</p>

# Download

You can download the release app on Google Play Store:

<a href="https://play.google.com/store/apps/details?id=xyz.teamgravity.todo">
<img alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" width="200"/>
</a>

# Tech stack

- [Kotlin](https://kotlinlang.org/): first class programming language for native Android development.
- [Kotlin Coroutines](https://github.com/Kotlin/kotlinx.coroutines): structured concurrency.
- [Kotlin Flows](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/): reactive communication.
- [Material3](https://m3.material.io/): modern UI/UX guidelines and components.
- [Jetpack Compose](https://developer.android.com/jetpack/compose): modern, declarative way of building UI in Kotlin.
- [Jetpack Lifecycle](https://developer.android.com/topic/libraries/architecture/lifecycle): observe Android lifecycles and handle UI states upon the lifecycle changes.
- [Jetpack ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel): manages UI-related data holder and lifecycle aware. Allows data to survive configuration changes such as screen rotations.
- [Dagger Hilt](https://dagger.dev/hilt/): first class dependency injection for native Android development.
- [Firebase](https://firebase.google.com/): tracks analytics and crashes using the Firebase services.
- [ExoPlayer2](https://exoplayer.dev/): an application level media player for Android.
- [Compose Destinations](https://composedestinations.rafaelcosta.xyz/): a type-safe navigation for composables.
- [Timber](https://github.com/JakeWharton/timber): a logger with a small, extensible API.

# Architecture

"Kichkina Shahzoda" is based on the MVVM architecture pattern, Repository pattern, Mapper pattern.

<img src="/mvvm-pattern.png"/>

# MAD Score

<p align="center">
<img src="/summary_1.png"/>
<img src="/summary_2.png"/>
</p>

# License

```xml
Designed and developed by 2022 skydoves (Jaewoong Eum)

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.
```

0 comments on commit d8ba98b

Please sign in to comment.