Git Product home page Git Product logo

pinaki93 / desipe Goto Github PK

View Code? Open in Web Editor NEW
25.0 3.0 5.0 17.59 MB

An Indian Recipe App ๐Ÿœ built on MVVM architecture ๐Ÿš€ with Kotlin, LiveData, Jetpack Navigation, Room, View Binding, Dagger Hilt, Coil, Retrofit, OkHTTP and Material Components

License: MIT License

Kotlin 100.00%
android mvvm mvvm-architecture kotlin jetpack jetpack-android koin coil-kotlin coil androidx

desipe's Introduction

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.

desipe's People

Contributors

pinaki93 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.