Create README.md

This commit is contained in:
Kadir Kuruca
2021-06-01 22:16:31 +03:00
committed by GitHub
parent 11417554ba
commit 85fc55422b

38
README.md Normal file
View File

@@ -0,0 +1,38 @@
# News App ✔️
#### A simple News App 📱 built to demonstrate the use of modern android architecture component with MVVM Architecture 🏗
The App is using the [News Api] to searching news.
### Build With 🏗️
- [Kotlin] - Programming language for Android
- [Hilt-Dagger] - Standard library to incorporate Dagger dependency injection into an Android application.
- [Retrofit] - A type-safe HTTP client for Android and Java.
- [Room] - SQLite object mapping library.
- [Coroutines] - For asynchronous
- [LiveData] - Data objects that notify views when the underlying database changes.
- [ViewModel] - Stores UI-related data that isn't destroyed on UI changes.
- [ViewBinding] - Generates a binding class for each XML layout file present in that module and allows you to more easily write code that interacts with views.
- [Jetpack Navigation] - Navigation refers to the interactions that allow users to navigate across, into, and back out from the different pieces of content within your app
- [Glide] - An image loading and caching library for Android focused on smooth scrolling
[ViewModel]: <https://developer.android.com/topic/libraries/architecture/viewmodel>
[Jetpack Navigation]: <https://developer.android.com/guide/navigation/>
[Hilt-Dagger]: <https://dagger.dev/hilt/>
[DataStore]: <https://developer.android.com/topic/libraries/architecture/datastore>
[ViewBinding]: <https://developer.android.com/topic/libraries/view-binding>
[LiveData]: <https://developer.android.com/topic/libraries/architecture/livedata/>
[Retrofit]: <https://square.github.io/retrofit/>
[ViewModel]: <https://developer.android.com/topic/libraries/architecture/viewmodel>
[Glide]: <https://github.com/bumptech/glide>
[Kotlin]: <https://kotlinlang.org>
[Coroutines]: <https://kotlinlang.org/docs/coroutines-overview.html>
[MVVM (Model View View-Model)]: <https://developer.android.com/jetpack/guide#recommended-app-arch>
[News Api]: <https://newsapi.org/>
[Room]: <https://developer.android.com/training/data-storage/room/>
### Project Architecture 🗼
This app uses [MVVM (Model View View-Model)] architecture.
![alt text](https://github.com/KadirKuruca/NewsApp-MVVM-Hilt-Room-Retrofit/blob/master/mvvm_architecture.png?raw=true)