Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshludahl/warbler-weather
Android Weather App utilizing the Open Weather API
https://github.com/joshludahl/warbler-weather
android android-app android-weather weather weather-app
Last synced: 12 days ago
JSON representation
Android Weather App utilizing the Open Weather API
- Host: GitHub
- URL: https://github.com/joshludahl/warbler-weather
- Owner: JoshLudahl
- Created: 2019-12-13T20:10:45.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-08T23:34:48.000Z (11 months ago)
- Last Synced: 2024-02-09T22:29:18.118Z (11 months ago)
- Topics: android, android-app, android-weather, weather, weather-app
- Language: Kotlin
- Homepage:
- Size: 1.03 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/JoshLudahl/Warbler-Weather/actions/workflows/android.yml)
# Warbler Weather
[About](https://softklass.com/weatheruous/)
[Privacy Policy](https://softklass.com/privacy-policy/weatheruous.html)
## A simple app for weather
The purpose of this app is to offer an unbiased view of weather data without all the fuss (ads, tracking, data mining).
The app is themed after the [Yellow-rumped Warbler](https://www.audubon.org/field-guide/bird/yellow-rumped-warbler) bird.
### Libraries used
* Written in [Kotlin](https://kotlinlang.org/)
* Uses Kotlin [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html)
* [Android Architecture Components](https://developer.android.com/topic/libraries/architecture)
* [Jetpack Navigation](https://developer.android.com/guide/navigation)
* [LiveData](https://developer.android.com/topic/libraries/architecture/livedata)
* [Flow](https://developer.android.com/kotlin/flow)
* [ViewBinding](https://developer.android.com/topic/libraries/view-binding)
* [DataBinding](https://developer.android.com/topic/libraries/data-binding)
* [Retrofit](https://square.github.io/retrofit/) - An HTTP client for Android
* [Room Database](https://developer.android.com/training/data-storage/room)
* [DataStore](https://developer.android.com/topic/libraries/architecture/datastore)
* Dependency Injection using [Dagger Hilt](https://dagger.dev/hilt/) for [Android](https://developer.android.com/training/dependency-injection/hilt-android)
* [Notifications](https://developer.android.com/develop/ui/views/notifications)
* [MVVM](https://developer.android.com/topic/architecture)
* [Material Design Components for Android](https://github.com/material-components/material-components-android)
* Testing includes
* [Mockito](https://developer.android.com/training/testing/local-tests) for unit testing
* [Espresso](https://developer.android.com/training/testing/espresso) for UI testing
* Charts by [Vico](https://github.com/patrykandpatrick/vico)
### Features
* City Finder
* Location Service
* Favorites
* [Weather Icons](https://erikflowers.github.io/weather-icons/)
* Current Weather data from [Open Weather Map](https://openweathermap.org/)
* Forecast
* Hourly
* Air Quality
## Architecture
This app uses [***MVVM (Model View View-Model)***](https://developer.android.com/jetpack/docs/guide#recommended-app-arch) architecture.
## Setup
In the ```build.gradle```, you will find an associated weather API key assigned, so you will want to
visit [Open Weather Map](https://openweathermap.org/api) and sign up to get an API key.
Once you have an API key, place it in your global ```gradle.properties``` file or in your environment.
It should look like this, replacing `````` with the actual key:
```WEATHER_API_KEY=```
## Tests
There are UI tests setup to run Espresso tests. Unit tests are also configured and uses Mockito.
## CI
This project is configured to run Github Actions and uses Dependabot for dependency updates.
The GitHub Actions will run both unit tests and UI tests on master, or pull requests.
## Contributing
Since this project is open source, contributing is encouraged.
## Attributions
Color theme by [Color Hunt](https://colorhunt.co/palette/222831393e46ffd369eeeeee), chosen to emulate
the color of the Yellow-rumped Warbler bird.
```
MIT License
Copyright (c) 2023 Josh Ludahl
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.
```