Giter VIP home page Giter VIP logo

praxis's Introduction

Praxis

2022 Hit Refresh! Praxis now loves โค๏ธ Jetpack Compose


This is a sample app written in Kotlin following clean architecture principles which uses slack app features as an example.

The purpose of this app to showcase:

  • Implementation of Jetpack Android Architecture components with Dagger Hilt and Data Binding to minimize boilerplate code.
  • Implementation of an architecture that will support both XML and the new Compose.
  • Implementation of Modular Multi Module Navigation Architecture.
  • Performing background task with Kotlin Coroutines

Requirements

  1. Android Studio : Arctic Fox | 2020.3.1 3.1 or higher
  2. Android Emulator or Physical android device

Built With ๐Ÿ—

Tools Link
๐Ÿค– Kotlin Kotlin
๐Ÿ› Architecture Components Android Architecture Components
โ›“ Data Binding Android Data Binding
๐Ÿ’‰ Dagger Hilt Dagger Hilt
๐ŸŒ Retrofit Retrofit
๐Ÿšฆ OkHttp OkHttp
๐Ÿ“„ Gson Parsing Gson
๐ŸŒŠ Coroutines Kotlin Coroutines
๐Ÿ„๐Ÿผโ€โ™€๏ธ Flows Flows

Architecture

Praxis follows the principles of Clean Architecture with Android Architecture Components.

Architecture's layers & boundaries:

Presentation Layer contains UI (Activities & Fragments) that are coordinated by ViewModels which execute 1 or multiple UseCases. Presentation Layer depends on Domain Layer.

Domain Layer is the most INNER part of the circle (no dependencies with other layers) and it contains Entities, Use cases & Repository Interfaces. Use cases combine data from 1 or multiple Repository Interfaces.

Data Layer contains Repository Implementations and 1 or multiple Data Sources. Repositories are responsible to coordinate data from the different Data Sources. Data Layer depends on Domain Layer.

Notes: Mapping between response models and transformed models will happen via extension functions defined in transformed model file

Conventions:

Files are suffixed with be defined Class types.

  • ViewModels are suffixed with VM. Ex: LoginVM
  • UseCases are suffixed with UseCase. Ex: LoginUseCase
  • Sources are suffixed with Source. Ex: LoginRemoteSource, LoginLocalSource
  • Repositories are suffixed with Repo. Ex: LoginRepo

Conclusion

This project can be used as a template for new apps. This project is continually evolving to integrate other libraries and techniques to keep it up to date.

praxis's People

Contributors

anmolvermamm avatar ashishmm avatar harintrivedimm avatar harish32150 avatar hiten avatar hitenpannu avatar niketmm avatar oianmol avatar phanirajabhandari avatar pushpalroy avatar pushpalroymm avatar shekarmm avatar shubhamsinghmutualmobile avatar suchomm avatar suchox avatar tushar-nallan avatar vartulmm avatar vartult avatar vikramsharmamm avatar vipulasri avatar vipulmm avatar vivekbhalodiyamm 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.