swapnil-musale / jetjoke Goto Github PK

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 & app (presentation). It also showcase the implemetation of some of the Modern Jetpack Architecture Component.

• Kotlin : Kotlin is statically typed & first-class language for Android Development.
• Coroutines : For Asynchronus or non-blocking operations.
• Flows : Data Streaming API which is built on top of Coroutines.
• Jetpack Compose : Toolkit for building native UI in a declarative way.
• Splash Screen API : Launch app with animation of launcher icon.
• Retrofit : Type-safe REST client for Android to consume RESTful web services.
• Dagger Hilt : Dependency injection library for Android.

• Kotlin DSL : For writing gradle script for Kotlin is more readable and offers better compile-time.
• Version Catalog : Declaring gradle dependencies & plugins in central place.
• Github Actions(CI/CD) : Automate the build, test, and deployment pipeline through Github Actions.
• Renovate : To keep the app dependencies up-tp-date automatically.

In this project we have integrated Konsist to protect Coding Standard & guard App Architecture from pushing accidental changes to git. Click Here to checkout test written for the same.

App is build using Clean Architecture design pattern. Which consist of three module as follows :

• 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.
• 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.
• data - This module is mainly responsible for accessing data from remote or local source which is being called from domain module only.

• Unit & UI tests are under ToDo list and will be done soon - please watch out this space after some time for more info this section.

• master - master branch will contain the production code which is deployed by CD Pipeline.
• 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.

• Display Joke by selected Category
• Search Joke functionality
• Unit Testing
• UI Testing
• Offline Capability for jokes

We 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 & If you have implemented some changes then raise the Pull request over development branch.

JetJoke project use Joke API to fetch and display joke's in app.

MIT License

Copyright (c) 2023 Swapnil Musale

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.