QuotiePie is an app that displays a random inspirational quote to help users start their day or stay motivated. It is built to demonstrate the use of Modern Android development (MAD) tools , based on MVVM Clean Architecture & Jetpack compose. 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 - First class and official programming language for Android development.
- Coroutines - For asynchronous and more..
- Flow - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
- Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
- ViewModel - Stores UI-related data that isn't destroyed on UI changes.
- Dependency Injection
- Koin - Koin is a smart Kotlin dependency injection library to keep you focused on your app, not on your tools. This is in the main branch.
- Retrofit - A type-safe HTTP client for Android and Java.
- Material Components for Android - Modular and customizable Material Design UI components for Android.
- Gradle Kotlin DSL - For writing Gradle build scripts using Kotlin.
- 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.
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.
Screen_recording_20230831_150030.mp4
- Coming soon
- master - master branch will contain the production code which is deployed by CD Pipeline.
- develop - develop branch will contain the on-going app feature developement or bug fix code which is targeted for upcoming release validated by CI Pipeline.
- Display Quote by selected Category
- Unit Testing
- UI Testing
- Offline Capability for quotes
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 develop branch.
QuotiePie project use Quotable API to fetch and display quotes in app.
MIT License
Copyright (c) 2023 Hamdi Guerbej
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.