diff --git a/README.md b/README.md new file mode 100644 index 0000000..3824268 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +

Android Study Case


+

+A demo Android Study Case app using compose and Hilt based on modern Android tech-stacks and MVI architecture. Fetching data from the network and integrating persisted data in the database via repository pattern.
Declarative UI version of the DisneyMotions using compose. +

+
+ +

+ License + API + Build Status + Medium + Profile +

+ +## Download +Go to the [Releases](https://github.com/eric-ampire/android-study-case/releases) to download the latest APK. + +## Screenshots +

+ + + +

+ +## Tech stack & Open-source libraries +- Minimum SDK level 21 +- 100% [Kotlin](https://kotlinlang.org/) based + [Coroutines](https://github.com/Kotlin/kotlinx.coroutines) + [Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/) for asynchronous. +- Hilt (alpha) for dependency injection. +- JetPack + - Compose - A modern toolkit for building native Android UI. + - LiveData - notify domain layer data to views. + - Lifecycle - dispose observing data when lifecycle state changes. + - ViewModel - UI related data holder, lifecycle aware. + - Room Persistence - construct database. + - App Startup - Provides a straightforward, performant way to initialize components at application startup. +- Architecture + - MVI Architecture (Declarative View - Intent - Model) + - Clear Architecture pattern +- Material Design & Animations +- [Accompanist](https://github.com/google/accompanist) - A collection of extension libraries for Jetpack Compose. +- [Orbit-MVI](https://github.com/skydoves/landscapist) - Jetpack Compose image loading library with shimmer & circular reveal animations. +- [Retrofit2 & OkHttp3](https://github.com/square/retrofit) - construct the REST APIs and paging network data. +- [Timber](https://github.com/JakeWharton/timber) - logging. + +## Find this repository useful? :heart: +Support it by joining __[stargazers](https://github.com/eric-ampire/android-study-case/stargazers)__ for this repository. :star:
+And __[follow](https://github.com/eric-ampire)__ me for my next creations! 🤩 + +# License +```xml +Designed and developed by 2020 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. +``` \ No newline at end of file