An open API service indexing awesome lists of open source software.

https://github.com/deepfine/mob_android_template_compose

Android template with MVI
https://github.com/deepfine/mob_android_template_compose

android compose kotlin mvi

Last synced: 6 months ago
JSON representation

Android template with MVI

Awesome Lists containing this project

README

          

# Android Template Compose
Build Status

## πŸš€ Overview
Scalable and maintainable Android application template built with:
- **Kotlin**
- **Jetpack Compose**
- **MVI (Model-View-Intent) architecture**
- **Multi-module structure**


## πŸš€ Quick Start
### Create a new repository
create_a_new_repository

### Configure .github/ISSUE_TEMPLATE/[issue-template.yml](https://github.com/deepfine/mob_android_template_compose/blob/develop/.github/ISSUE_TEMPLATE/issue-template.yml) with Jira's Epic ID
jira-epic-id

```yml
body:
- type: input
id: parentKey
attributes:
label: '🎟️ μƒμœ„ μž‘μ—… (Epic ID)'
description: 'μƒμœ„ μž‘μ—…μ˜ Epic IDλ₯Ό κΈ°μž…ν•΄μ£Όμ„Έμš”.'
value: 'DF-7' // TODO : Jira Epic ID
validations:
required: true
```

### Add ruleset to your repository
[ruleset-develop.json](https://github.com/user-attachments/files/24629673/ruleset-develop.json)

import_ruleset




## πŸ—‚ Project structure
```
/
β”œβ”€β”€ app/ # Appplication module
β”œβ”€β”€ data-api/ # Data layer interfaces
β”œβ”€β”€ data-impl/ # Data layer implementations
β”œβ”€β”€ navigator/ # Navigation abstraction
β”œβ”€β”€ presentation/ # Components shared in presentation layers
β”‚ └── sub-modules/ # UI, ViewModels, MVI contracts
β”œβ”€β”€ build-logic/ # Custom Gradle plugins & convention logic
β”œβ”€β”€ buildconfig-stub/ # BuildConfig template module
β”œβ”€β”€ gradle/ # Gradle wrapper & version catalogs
└── scripts/ # Utility scripts
```


## βš™οΈ Requirements
- **Android Studio Narwhal or newer**
- **JDK 17**


## πŸ“ Conventions
### Repository Name
`mob_${Project Name}_android_${device}`
βœ… mob_dao_android / mob_dao_android_glass