|Main Screen Dark
It simply loads data from API and stores it in persistence storage (i.e. SQLite Database). Data will be always loaded from local database. Remote data (from API) and Local data is always synchronized.
- This makes it offline capable 😃.
- Clean and Simple Material UI.
- It supports dark theme too 🌗.
🚀 Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Android Studio 3.2+
- Java JDK
Follow these steps if you want to get a local copy of the project on your machine.
1. Clone or fork the repository by running the command below
2. Import the project in AndroidStudio, and add API Key
- In Android Studio, go to File -> New -> Import project
- Follew the dialog wizard to choose the folder where you cloned the project and click on open.
- Android Studio imports the projects and builds it for you
🤝 How to Contribute
- Fork it
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request
📃 Libraries used
Kotlin - First class and official programming language for Android development.
Coroutines - For asynchronous and more..
Flow - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
Hilt - Jetpack Dependency Injection Framework
Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
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.
Room - SQLite object mapping library.
WorkManager - WorkManager is an API that makes it easy to schedule deferrable, asynchronous tasks that are expected to run even if the app exits or the device restarts.
Dagger 2 - Dependency Injection Framework
Retrofit - A type-safe HTTP client for Android and Java.
Coil-kt - An image loading library for Android backed by Kotlin Coroutines.
Material Components for Android - Modular and customizable Material Design UI components for Android.
This project is released under the MIT license.
See LICENSE for details.
Copyright (c) 2020 Hari Choudhary
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE