{"id":13610771,"url":"https://github.com/mayokunadeniyi/Instant-Weather","last_synced_at":"2025-04-13T01:32:49.259Z","repository":{"id":38291427,"uuid":"236161392","full_name":"mayokunadeniyi/Instant-Weather","owner":"mayokunadeniyi","description":"An Android weather application implemented using the MVVM pattern, Retrofit2, Dagger Hilt, LiveData, ViewModel, Coroutines, Room, Navigation Components, Data Binding and some other libraries from the Android Jetpack.","archived":false,"fork":false,"pushed_at":"2024-06-04T22:47:19.000Z","size":1976,"stargazers_count":769,"open_issues_count":9,"forks_count":164,"subscribers_count":20,"default_branch":"main","last_synced_at":"2024-11-07T17:45:20.295Z","etag":null,"topics":["algolia-instantsearch","coroutines-android","dagger-hilt","databinding","dependency-injection","livedata","material-design","mvvm-pattern","navigation-architecture-component","paging-library","retrofit2","room-persistence-library","timber"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mayokunadeniyi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-25T11:30:29.000Z","updated_at":"2024-11-05T16:58:29.000Z","dependencies_parsed_at":"2024-06-11T22:01:36.761Z","dependency_job_id":null,"html_url":"https://github.com/mayokunadeniyi/Instant-Weather","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mayokunadeniyi%2FInstant-Weather","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mayokunadeniyi%2FInstant-Weather/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mayokunadeniyi%2FInstant-Weather/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mayokunadeniyi%2FInstant-Weather/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mayokunadeniyi","download_url":"https://codeload.github.com/mayokunadeniyi/Instant-Weather/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248654037,"owners_count":21140236,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["algolia-instantsearch","coroutines-android","dagger-hilt","databinding","dependency-injection","livedata","material-design","mvvm-pattern","navigation-architecture-component","paging-library","retrofit2","room-persistence-library","timber"],"created_at":"2024-08-01T19:01:47.846Z","updated_at":"2025-04-13T01:32:48.446Z","avatar_url":"https://github.com/mayokunadeniyi.png","language":"Kotlin","funding_links":[],"categories":[":art: Pattern","Kotlin"],"sub_categories":["MVVM"],"readme":"![](media/instant_weather_github.png)\n# Instant Weather :partly_sunny:\n\n![Android Build](https://github.com/mayokunthefirst/Instant-Weather/workflows/Android%20Build/badge.svg) ![Android Weekly](https://androidweekly.net/issues/issue-413/badge) [![BCH compliance](https://bettercodehub.com/edge/badge/mayokunthefirst/Instant-Weather?branch=master)](https://bettercodehub.com/) ![My twitter](https://img.shields.io/twitter/url?style=social\u0026url=https%3A%2F%2Ftwitter.com%2Fmayokunadeniyi) ![Shield](https://img.shields.io/badge/contributions-welcome-brightgreen)\n\nAn Android weather application implemented using the MVVM pattern, Retrofit2, Dagger Hilt, LiveData, ViewModel, Coroutines, Room, Navigation Components, Data Binding and some other libraries from the [Android Jetpack](https://developer.android.com/jetpack) . Instant Weather fetches data from the [OpenWeatherMap API](https://openweathermap.org/api) to provide real time weather information. It also makes use of the [Algolia Instant Search](https://www.algolia.com/products/instantsearch/) service which enables you search for weather conditions of various locations.\n\n\u003ca href='https://play.google.com/store/apps/details?id=com.mayokunadeniyi.instantweather\u0026pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'\u003e\u003cimg alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width=\"280\"/\u003e\u003c/a\u003e\n\n## Architecture\nThe architecture of this application relies and complies with the following points below:\n* A single-activity architecture, using the [Navigation Components](https://developer.android.com/guide/navigation) to manage fragment operations.\n* Pattern [Model-View-ViewModel](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93viewmodel)(MVVM) which facilitates a separation of development of the graphical user interface.\n* [Android architecture components](https://developer.android.com/topic/libraries/architecture/) which help to keep the application robust, testable, and maintainable.\n\n\u003cp align=\"center\"\u003e\u003ca\u003e\u003cimg src=\"https://raw.githubusercontent.com/mayokunthefirst/Instant-Weather/master/media/final-architecture.png\" width=\"700\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n## Technologies used:\n\n* [Retrofit](https://square.github.io/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.\n* [Dagger Hilt](https://dagger.dev/hilt/) for dependency injection.\n* [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) to store and manage UI-related data in a lifecycle conscious way.\n* [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) to handle data in a lifecycle-aware fashion.\n* [Navigation Component](https://developer.android.com/guide/navigation) to handle all navigations and also passing of data between destinations.\n* [Timber](https://github.com/JakeWharton/timber) - a logger with a small, extensible API which provides utility on top of Android's normal Log class.\n* [Algolia Search API - Android](https://www.algolia.com/doc/guides/building-search-ui/getting-started/android/) to quickly and seamlessly implement search within the application.\n* [Work Manager](https://developer.android.com/topic/libraries/architecture/workmanager) to manage Android background jobs.\n* [Material Design](https://material.io/develop/android/docs/getting-started/) an adaptable system of guidelines, components, and tools that support the best practices of user interface design.\n* [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) 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.\n* [Data Binding](https://developer.android.com/topic/libraries/data-binding/) to declaratively bind UI components in layouts to data sources.\n* [Room](https://developer.android.com/topic/libraries/architecture/room) persistence library which provides an abstraction layer over SQLite to allow for more robust database access while harnessing the full power of SQLite.\n* [Paging Library](https://developer.android.com/topic/libraries/architecture/paging) helps you load and display small chunks of data at a time.\n* [Android KTX](https://developer.android.com/kotlin/ktx) which helps to write more concise, idiomatic Kotlin code.\n* [Preferences](https://developer.android.com/guide/topics/ui/settings) to create interactive settings screens.\n\n## Installation\nInstant Weather requires a minimum API level of 21. Clone the repository. You will need an API key i.e. `API_KEY` from [Open Weather](https://openweathermap.org/) to request data. If you don’t already have an account, you will need to create one in order to request an API Key. Also, you will need to create an app on [Algolia](https://www.algolia.com/doc/). \n\nGenerate a search only API key i.e. `ALGOLIA_API_KEY`, the APP ID i.e. `ALGOLIA_APP_ID` for the app you created and then create an [Index](https://www.algolia.com/doc/faq/basics/what-is-an-index/) under that app, you will need the index name i.e. `ALGOLIA_INDEX_NAME` to setup the search functionality in this application. You can populate the index with records from [here](https://drive.google.com/file/d/1o-btuAm1bxAwKzd41DP8-1mToTc1QQz-/view?usp=sharing). \n\nEach record follows this structure:\n\n````JSON\n{\n    \"objectID\": \"ffe74e4cdddbc_dashboard_generated_id\",\n    \"country\": \"Zimbabwe\",\n    \"geonameid\": 1085510,\n    \"name\": \"Epworth\",\n    \"subcountry\": \"Harare\"\n}\n  \n````\n\nIn your project's root directory, inside the `local.properties` file (create one if unavailable) include the following lines:\n\n````properties\nAPI_KEY = \"YOUR_API_KEY\"\nALGOLIA_API_KEY = \"YOUR_API_KEY\"\nALGOLIA_APP_ID = \"YOUR_APP_ID\"\nALGOLIA_INDEX_NAME = \"YOUR_INDEX_NAME\"\n\n````\n## Contribution\nAll contributions are welcome. If you are interested in seeing a particular feature implemented in this app, please open a new issue after which you can make a PR!\n\n![Alt](https://repobeats.axiom.co/api/embed/84dfd3cd94832805dbcaa3569ec855d19e5c9401.svg \"Repobeats analytics image\")\n\n## LICENSE\n```\nMIT License\n\nCopyright (c) 2020 Mayokun Adeniyi\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmayokunadeniyi%2FInstant-Weather","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmayokunadeniyi%2FInstant-Weather","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmayokunadeniyi%2FInstant-Weather/lists"}