Praxis - GitLite

KO | EN

gitlite — search

#react #ai #llm #android #machine-learning #rust #deep-learning #linux #nodejs #macos #awesome #cli #vue #ios

Praxis

(★ 373)

Example Android project using MVVM, DaggerAndroid, Jetpack Compose, Retrofit, Coroutines and Multi module architecture ✌🏽

파일 탐색기

최종 버전 다운로드 (.zip)

- - build.yml
- - praxis-debug.jks
  - praxis-release.jks
- .gitignore
- build.gradle.kts
- fabric.properties
- proguard-common.txt
- proguard-rules.pro
- proguard-specific.txt
- animated_search.gif
- animated_start.gif
- architecture.jpeg
- art1.png
- art2.png
- art3.png
- art4.png
- art5.png
- art6.png
- art8.gif
- art9.png
- clean-architecture.jpg
- build.gradle.kts
- .gitignore
- build.gradle.kts
- consumer-rules.pro
- proguard-rules.pro
- .gitignore
- build.gradle.kts
- consumer-rules.pro
- proguard-rules.pro
- .gitignore
- build.gradle.kts
- proguard-rules.pro
- .gitignore
- build.gradle.kts
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- .gitignore
- build.gradle.kts
- consumer-rules.pro
- proguard-rules.pro
- - pre-commit.sh
- git-hooks.gradle.kts
- .gitignore
- build.gradle.kts
- consumer-rules.pro
- proguard-rules.pro
- .gitignore
- build.gradle.kts
- consumer-rules.pro
- proguard-rules.pro
.gitignore
build.gradle.kts
gradle.properties
gradlew
gradlew.bat
LICENSE
README.md
settings.gradle.kts

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/griddynamics-archive/Praxis

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd Praxis

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Gradle (Java/Kotlin)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java/Kotlin 프로젝트를 빌드/실행하려면 필요합니다.
Gradle 레포에 포함된 gradlew(Gradle Wrapper)를 쓰면 Gradle을 따로 설치할 필요가 없습니다.

cd app

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

./gradlew build

Gradle로 빌드를 진행합니다.

✅ BUILD SUCCESSFUL 메시지가 뜨면 성공입니다. build/ 폴더에 결과물이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Praxis
2022 Hit Refresh! Praxis now loves ❤️ Jetpack Compose

<div align="left">
    <a href = "https://developer.android.com/jetpack/androidx/versions/all-channel#may_5_2021">
        <img src = "https://img.shields.io/badge/Jetpack%20Compose-1.0.0%20beta08-brightgreen" />
    </a>
</div>
<br>

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](https://kotlinlang.org/) |
| 🏛   Architecture Components | [Android Architecture Components](https://developer.android.com/topic/libraries/architecture) |
| ⛓   Data Binding | [Android Data Binding](https://developer.android.com/topic/libraries/data-binding) |
| 💉   Dagger Hilt | [Dagger Hilt](https://developer.android.com/training/dependency-injection/hilt-android) |
| 🌐   Retrofit | [Retrofit](http://square.github.io/retrofit/) |
| 🚦   OkHttp | [OkHttp](http://square.github.io/okhttp/) |
| 📄   Gson Parsing | [Gson](https://github.com/google/gson) |
| 🌊   Coroutines | [Kotlin Coroutines](https://developer.android.com/kotlin/coroutines) |
| 🏄🏼‍♀️   Flows | [Flows](https://developer.android.com/kotlin/flow) |

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

### Architecture's layers & boundaries:

<img src="art/architecture.jpeg" />

**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.