Desipe Save

An Indian Recipe App 🍜 built on MVVM architecture 🚀 with Kotlin, LiveData, Jetpack Navigation, Room, View Binding, Dagger Hilt, Coil, Retrofit, OkHTTP and Material Components

Project README

Desipe 🥘

Desipe is a simple app listing a few Indian recipes, created to demonstrate some of the commonly used libraries in Android development.

Download 📥

The release APK can be downloaded from here.

Architecture 🏗️

I've used Google recommended app architecture following Model-View-ViewModel (MVVM) architecture, exposing PresentationModel out from the ViewModel wrapped in LiveData to updated the UI in a lifecycle aware manner.

Libraries Used 📚

UI:
🚀 AndroidX libraries (Core/AppCompat/ConstraintLayout/RecyclerView)
🚀 Material Design

Transitions:
🚀 Jetpack Navigation

Threading:
🚀 Kotlin Coroutine

Dependency Injection:
🚀 Dagger-Hilt

SQLite:
🚀 Room Database

Image loading/animations:
🚀 Coil-Kt
🚀 Lottie

HTTP Operations:
🚀 Retrofit
🚀 Okhttp

JSON serialization/deserialization:
🚀 Moshi

Mocking/Spying test objects:
🚀 Mockk

Data ☁️

Data is a dummy set of JSON and images hosted on a github page. Most of the content is still dummy. Please feel free to clone this repo and add/modify content under the recipes folder.

Dark Theme 🌙

Support for Dark Theme is available. However, there is a small bug for Android 10 and above that the theme doesn't get updated when user selects Follow System from the bottom sheet. Upon killing the app once and returning back, the theme gets updated.

TODO 🔨

🛠️ Set Up CI using either Github Workflow or CircleCI
🛠️ Add lint support
🛠️ Write UI tests and increase test coverage.

Screenshots 📷

Light Theme:

Dark Theme:

Art

I made a humble attempt to create the app icon by myself 💩 using Inkscape a free and open source vector graphics editor available across MacOS, Windows and Linux.

License

MIT License

Copyright (c) 2020 Pinaki Acharya

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.
Open Source Agenda is not affiliated with "Desipe" Project. README Source: Pinaki93/Desipe

Open Source Agenda Badge

Open Source Agenda Rating