s12dar / cloudy

Weather information based on your current location, as well as a week-long forecast

cloudy ☁️ (work in progress)

Cloudy is an open-source weather app for Android that provides users with up-to-date weather information based on their current location, as well as a week-long forecast. It is built using the latest Android technologies and follows the MVVM with clean architecture, with an offline-first approach that caches weather data for improved performance.

Tech stack 🏗

• Kotlin
• Jetpack Components - Compose, ViewModel and more
• Dagger Hilt
• Coroutines & Flow
• Retrofit
• OkHttp3
• JUnit & Mockito
• Fastlane

Development Setup

To build and run the app, you will need the latest version of Android Studio Giraffe (or newer) installed on your system.

Weather API

The weather data is provided by the Open Weather API, which requires an API key. To store your Open Weather API key, add it to your local.properties file as follows:

OPEN_WEATHER_API_KEY=[YOUR_API_KEY]

The app retrieves the user's location using the device's GPS and uses the latitude and longitude to fetch the current weather and forecast for the next five days from the Open Weather API.

Contributions

All contributions to Cloudy are welcome! Just pick an issue and leave a comment before you start working on it.

Todos

Here are some areas of improvement that I'm currently working on:

• Increase test coverage
• Improve buildSrc
• Enhance modularization

LICENSE 📄

MIT License

Copyright (c) 2023 s12dar

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.

cloudy's Issues

Fix the context issue in manageLocation function

Fix the context issue in manageLocation function to make it easier for unit testing, it's hardcoded rn.
(Preferably to manage it in mapper)

create a widget of cloudy

Migrating build logic from Groovy to Kotlin

Via documentation:

Android Gradle plugin 4.0 added support for using Kotlin script (KTS) in your Gradle build configuration as a replacement for Groovy, the programming language traditionally used in Gradle configuration files.

In the future, KTS will be preferred over Groovy for writing Gradle scripts because Kotlin is more readable and offers better compile-time checking and IDE support.

Although KTS currently offers better integration in Android Studio’s code editor when compared to Groovy, builds using KTS tend to be slower than builds using Groovy, so consider build performance when deciding whether to migrate to KTS.

create workflow(s) to automate deployment process

go through all the composables

There are performance issues in presentation layer therefore the layer needs maintenance

app doesn't load in first time when it gets location permissions

optimize clean architecture modularization

as multiple features are added better modularization needs to be done

change open-meteo API to open weather API to get more accurate results

Ps. Data layer of the app is undergoing significant changes.