Meet - Android Multi-Module Template

🌐 Languages:

• 🇬🇧 English (default)
• 🇪🇸 Español

Note

JDK 21 is required to compile this project.

This project is a modern Android base template, designed with a focus on scalability, maintainability, and modularization. It uses a robust multi-module architecture following Clean Architecture principles, allowing for a clear separation of concerns and facilitating teamwork or project growth.

The goal of this template is to provide a pre-configured structure with industry best practices, including dependency injection, modern navigation, and strict code quality controls.

Important

Proof of Concept: This project is a PoC exploring extreme modularization. Every single layer (datasource, repository, usecases, etc.) is isolated into its own Gradle module to ensure absolute architectural purity and total isolation. Trade-off: This approach results in high Gradle configuration overhead and significantly longer synchronization times. It is intended for educational purposes or extremely large-scale projects where strict boundary enforcement is a priority over build speed.

---

Architecture

Simplified Module and Relationship Diagram

Note

For better readability, this diagram has been simplified: the auth feature is not shown, and direct dependencies from :core:di and :core:common to other modules have been omitted to reduce visual clutter.

graph TD
    subgraph App_Level [Application]
        APP[:app]
    end

    subgraph Core_Level [Core Level]
        core_di[:core:di]
        core_nav[:core:navigation]
        core_ui[:core:ui]
        core_vmb[:core:viewmodels]
        core_com[:core:common]
    end

    subgraph Feature_AppRoot [Feature: app-root]
        root_ui[:app-root:presentation:ui]
        root_vm[:app-root:presentation:viewmodels]
        root_uc[:app-root:domain:usecases]
        root_repo[:app-root:domain:repository]
        root_models[:app-root:domain:models]
        root_data[:app-root:data:repository]
        root_ds[:app-root:data:datasource]
    end

    %% APP Dependencies
    APP --> core_di
    APP --> core_ui
    APP --> root_ui
    APP --> root_vm

    %% App-Root Flow
    root_ui --> core_ui
    root_ui --> core_vmb
    root_ui --> core_nav
    root_ui --> root_vm

    root_vm --> core_vmb
    root_vm --> root_models
    root_vm --> root_uc

    root_uc --> root_repo
    root_uc --> root_models

    root_data --> root_models
    root_data --> root_repo

Loading

Structure Summary

• :app: The main orchestrator. It depends on all features (auth, app-root) and configures global dependency injection and navigation.
• Features (auth, app-root): Each is internally divided following Clean Architecture:
  • :presentation: Contains the UI (Compose) and ViewModels. Depends on :domain.
  • :data: Implements repositories and data sources (API, Database). Depends on :domain.
  • :domain: The business logic core (UseCases and Models). No external dependencies from higher layers.
• :core: Contains reusable code for any module (common UI components, navigation utilities, ViewModel base logic, and dependency injection).
• :detekt-architecture-rules: Specialized module to ensure architecture rules are met through static analysis.

Features

• Multi-module project
• Clean Architecture
• Koin
• Data Store
• Compose Navigation
• Detekt
• Detekt custom rules
• Detekt Pre-Commit Hook

Warning!! 💥

This project contains a pre-commit and pre-push hook to ensure code quality. The following steps are necessary to setup the quality control:

1. Change hooksPath:

$ git config core.hooksPath .githooks

2. Add permissions to the hook:

$ chmod +x .git/hooks/pre-commit .git/hooks/pre-push

To fix the errors reported by the pre-commit hook, run this command in your terminal:

$ ./gradlew detekt

Kotzilla

Kotzilla is an SDK for monitoring and optimizing performance. To set it up:

1. Locate app/kotzilla.sample.json.
2. Create a copy named app/kotzilla.json (this file is ignored by Git to protect your keys).
3. Replace the placeholder values with your actual account credentials.

For more information, ensure you have the Koin plugin installed and connected to your account.