{"id":13613885,"url":"https://github.com/swapnil-musale/JetJoke","last_synced_at":"2025-04-13T18:31:47.355Z","repository":{"id":182727287,"uuid":"668784864","full_name":"swapnil-musale/JetJoke","owner":"swapnil-musale","description":"JetJoke App build using Jetpack Compose by following Clean + MVVM Architecture and with other Android Modern Architecture Component.","archived":false,"fork":false,"pushed_at":"2025-04-09T19:56:26.000Z","size":794,"stargazers_count":44,"open_issues_count":13,"forks_count":9,"subscribers_count":3,"default_branch":"development","last_synced_at":"2025-04-09T20:43:15.367Z","etag":null,"topics":["android","android-architecture","ci-cd-pipeline","clean-architecture","coroutine","flow","git-workflow","github-actions","hilt","jetpack-compose","konsist","kotlin","kotlin-dsl","material3","moshi","mvvm","retrofit","version-catalog"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swapnil-musale.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-07-20T15:26:03.000Z","updated_at":"2025-03-01T02:44:45.000Z","dependencies_parsed_at":"2023-09-28T01:03:31.655Z","dependency_job_id":"0b5762fa-3a78-4179-9351-dcb12952de60","html_url":"https://github.com/swapnil-musale/JetJoke","commit_stats":null,"previous_names":["swap-musale/jetjoke","swapnil-musale/jetjoke"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swapnil-musale%2FJetJoke","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swapnil-musale%2FJetJoke/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swapnil-musale%2FJetJoke/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swapnil-musale%2FJetJoke/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swapnil-musale","download_url":"https://codeload.github.com/swapnil-musale/JetJoke/tar.gz/refs/heads/development","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248760406,"owners_count":21157352,"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":["android","android-architecture","ci-cd-pipeline","clean-architecture","coroutine","flow","git-workflow","github-actions","hilt","jetpack-compose","konsist","kotlin","kotlin-dsl","material3","moshi","mvvm","retrofit","version-catalog"],"created_at":"2024-08-01T20:00:54.511Z","updated_at":"2025-04-13T18:31:47.022Z","avatar_url":"https://github.com/swapnil-musale.png","language":"Kotlin","funding_links":[],"categories":[":shamrock:  **Categories**","Kotlin"],"sub_categories":[":office: Architecture"],"readme":"\u003cbr/\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/swapnil-musale/jetjoke\"\u003e\n    \u003cimg src=\"https://github.com/swapnil-musale/JetJoke/assets/15209914/bb626d76-701c-4618-a724-6562e621d71a\" alt=\"Logo\" width=\"120\" height=\"120\"\u003e\n  \u003c/a\u003e\n\n  \u003ch2 align=\"center\"\u003eJetJoke - Joke Generator App\u003c/h2\u003e\n\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/swapnil-musale/JetJoke/actions\"\u003e\u003cimg alt=\"Android CI Pipeline\" src=\"https://github.com/swapnil-musale/JetJoke/actions/workflows/android_ci.yml/badge.svg?event=pull_request\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/swapnil-musale/JetJoke/stargazers\"\u003e\u003cimg alt=\"Github Repository starred\" src=\"https://img.shields.io/github/stars/swapnil-musale/jetjoke\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://www.codefactor.io/repository/github/swapnil-musale/jetjoke\"\u003e\u003cimg alt=\"CodeFactor\" src=\"https://www.codefactor.io/repository/github/swapnil-musale/jetjoke/badge\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://codebeat.co/projects/github-com-swapnil-musale-jetjoke-master\"\u003e\u003cimg alt=\"Codebeat Badge\" src=\"https://codebeat.co/badges/c8e985e0-5377-4c2c-9705-abf273eef427\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://opensource.org/licenses/Apache-2.0\"\u003e\u003cimg alt=\"Apache License\" src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## ℹ️ Project Info : \n**JetJoke App** is build to demonstrate the use of Clean Architecture + MVVM in Android App Development. App is mainly divided into 3 layers i.e ```data```, ```domain``` \u0026 ```app``` (presentation).\nIt also showcase the implemetation of some of the Modern Jetpack Architecture Component.\n\n## ⬇️ Download App :\n\u003ca href=\"https://play.google.com/store/apps/details?id=com.devx.jetjoke\"\u003e\u003cimg alt=\"Get it on Google Play\" src=\"https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png\" height=80px /\u003e\n\n## 👨‍💻 App Demo :\n### Screenshot\n\u003cimg src = \"https://github.com/swapnil-musale/JetJoke/assets/15209914/53bac1df-21bc-4db8-bf42-74f55cf9ebf6.png\" width=250/\u003e\n\n### Video\n[Video Demo](https://github.com/swapnil-musale/JetJoke/assets/15209914/15d49fc6-666f-4acd-9b16-b590fe0df464)\n\n## 📚 Libraries Used :\n* [Kotlin][0] : Kotlin is statically typed \u0026 first-class language for Android Development.\n* [Coroutines][1] : For Asynchronus or non-blocking operations.\n* [Flows][2] : Data Streaming API which is built on top of Coroutines.\n* [Jetpack Compose][3] : Toolkit for building native UI in a declarative way.\n* [Splash Screen API][4] : Launch app with animation of launcher icon.\n* [Retrofit][5] : Type-safe REST client for Android to consume RESTful web services.\n* [Dagger Hilt][6] : Dependency injection library for Android.\n\n[0]:  https://kotlinlang.org/\n[1]:  https://kotlinlang.org/docs/coroutines-overview.html\n[2]:  https://developer.android.com/kotlin/flow\n[3]:  https://developer.android.com/jetpack/compose\n[4]:  https://developer.android.com/develop/ui/views/launch/splash-screen\n[5]:  https://github.com/square/retrofit\n[6]:  https://dagger.dev/hilt/\n\n## 🧰 Other Tools :\n* [Kotlin DSL][7] : For writing gradle script for Kotlin is more readable and offers better compile-time.\n* [Version Catalog][8] : Declaring gradle dependencies \u0026 plugins in central place.\n* [Github Actions(CI/CD)][9] : Automate the build, test, and deployment pipeline through Github Actions.\n* [Renovate][10] : To keep the app dependencies up-tp-date automatically.\n\n[7]:  https://docs.gradle.org/current/userguide/kotlin_dsl.html\n[8]:  https://docs.gradle.org/current/userguide/platforms.html\n[9]:  https://github.com/features/actions\n[10]: https://docs.renovatebot.com/\n\n## 🏗️ App Architecture :\nIn this project we have integrated [**Konsist**](https://github.com/LemonAppDev/konsist) to protect Coding Standard \u0026 guard App Architecture from pushing accidental changes to git. [**Click Here**](https://github.com/swapnil-musale/JetJoke/tree/development/app/src/test/java/com/devx/jetjoke/konsist) to checkout test written for the same.\n\nApp is build using Clean Architecture design pattern. Which consist of three module as follows :\n* [**app**](https://github.com/swapnil-musale/JetJoke/tree/master/app) - This module is responsible for handling user interaction, displaying data and managing user interface. Usually this module is decoupled from bossiness logic and communicate with domain module for accessing any data.\n* [**domain**](https://github.com/swapnil-musale/JetJoke/tree/master/domain) - In this module contains core bussiness logic and it doesn't contains any platform related api usage and should only use java/kotlin language apis.\n* [**data**](https://github.com/swapnil-musale/JetJoke/tree/master/data) - This module is mainly responsible for accessing data from remote or local source which is being called from domain module only.\n\n![Clean-Architecture-in-Android](https://github.com/swapnil-musale/JetJoke/assets/15209914/526ea05d-d3d1-49da-b034-74628871a774)\n\n## 🧪 Testing (ToDo):\n* Unit \u0026 UI tests are under ToDo list and will be done soon - please watch out this space after some time for more info this section.\n\n## 🌿 Branches :\n* [**master**](https://github.com/swapnil-musale/JetJoke) - master branch will contain the production code which is deployed by [CD Pipeline](https://github.com/swapnil-musale/JetJoke/actions/workflows/android_cd.yml).\n* [**development**](https://github.com/swapnil-musale/JetJoke/tree/development) - development branch will contain the on-going app feature developement or bug fix code which is targeted for upcoming release validated by [CI Pipeline](https://github.com/swapnil-musale/JetJoke/actions/workflows/android_ci.yml).\n\n## 🚧 ToDo's :\n- [ ] Display Joke by selected Category\n- [ ] Search Joke functionality\n- [ ] Unit Testing\n- [ ] UI Testing\n- [ ] Offline Capability for jokes\n\n## 🙌 Contributions :\nWe welcome contributions to improve this project, Whether you want to fix a bug, implement a new feature, or suggest an enhancement, we're open to your ideas. Please create the issue at [here](https://github.com/swapnil-musale/JetJoke/issues) \u0026 If you have implemented some changes then raise the Pull request over ```development``` branch.\n\n## 🤝 acknowledgement :\nJetJoke project use [Joke API](https://sv443.net/jokeapi/v2/) to fetch and display joke's in app.\n\n## Connect with me:\n[![Github Profile](https://skillicons.dev/icons?i=github)](https://github.com/swapnil-musale)\n[![LinkedIn](https://skillicons.dev/icons?i=linkedin)](https://linkedin.com/in/swapnil-musale)\n\n## License :\n```\nMIT License\n\nCopyright (c) 2023 Swapnil Musale\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\n\u003c/br\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswapnil-musale%2FJetJoke","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswapnil-musale%2FJetJoke","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswapnil-musale%2FJetJoke/lists"}