An Android weather application implemented using the MVI pattern and clean architecture, Retrofit2, Dagger Hilt, Kotlin Flows, ViewModel, Coroutines, Room, Jetpack Compose, Kotlin DSL and some other libraries from the Android Jetpack . SafTech Weather fetches data from the Weather API to provide real time weather information.
The architecture of this application relies and complies with the following points below:
- Pattern Model-View-Intent(MVI) with Clean Architecture which facilitates separation of different layers of the application.
- Android architecture components which help to keep the application robust, testable, and maintainable.
- Jetpack Compose - A modern toolkit for building native Android UI
- Gradle Kotlin DSL - An alternative syntax for writing Gradle build scripts using Kotlin.
- Version Catalogs - A scalable way of maintaining dependencies and plugins in a multi-module project.
- Retrofit a REST Client for Android which makes it relatively easy to retrieve and upload JSON (or other structured data) via a REST based webservice.
- Dagger Hilt for dependency injection.
- ViewModel to store and manage UI-related data in a lifecycle conscious way.
- StateFlow to enable flows to emit updated state and emit values to multiple consumers optimally.
- Kotlin Flow to emit a stream of data with multiple values sequentially.
- Timber - a logger with a small, extensible API which provides utility on top of Android's normal Log class.
- Material Design an adaptable system of guidelines, components, and tools that support the best practices of user interface design.
- Coroutines used to manage the local storage i.e.
writing to and reading from the database. Coroutines help in managing background threads and reduces the need for callbacks. - Room persistence library which provides an abstraction layer over SQLite to allow for more robust database access while harnessing the full power of SQLite.
- Paging Library helps you load and display small chunks of data at a time.
- Android KTX which helps to write more concise, idiomatic Kotlin code.
- :TO BE UPDATED
SafTech Weather requires a minimum API level of 24. Clone the repository. You will need an API key i.e. API_KEY from Weather API to request data. If you don’t already have an account, you will need to create one in order to request an API Key.
In your project's root directory, inside the local.properties file (create one if unavailable) include the following lines:
BASE_URL = "http://api.weatherapi.com/v1/"
API_KEY = "YOUR_API_KEY"
MIT License
Copyright (c) 2024 Tom Munyiri
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
SOFTWARE.