Home

Welcome to Mifos Mobile Wiki

Quick Navigation

Getting Started

1. Set up an Environment
2. Project Setup
3. Committing Your Changes

Development Guidelines

• Commit Style Guide
• Squashing Commits

Project Modules

project-root/ Mifos Mobile
│
├── buildLogic/                # Shared build configuration(Gradle)
│
├── core/                      # Core business logic module
│   ├── common/                # Common code shared across platforms(KMP)
│   ├── model/                 # Model classes and data structures(KMP)
│   ├── data/                  # Data models and repositories(KMP)
│   ├── network/               # Networking and API clients(KMP)
│   ├── domain/                # Domain-specific logic(KMP)
│   ├── ui/                    # UI components and screens(CMP)
│   ├── designsystem/          # App-wide design system(CMP)
│   └── datastore/             # Local data storage(KMP)
│
├── feature/                   # CMP Feature Specific module
│   ├── about/                 # CMP about specific module
│   ├── accounts/              # CMP account specific module
│   ├── auth/                  # CMP auth specific module
│   ├── beneficiary/           # CMP beneficary specific logic
│   ├── client-charge/         # CMP faq specific logic
│   ├── guarantor/             # CMP guarantor specific logic
│   ├── help/                  # CMP help specific logic
│   ├── home/                  # CMP home specific logic
│   ├── loan/                  # CMP loan specific logic
│   ├── location/              # CMP location specific logic
│   ├── notifiaction/          # CMP notification specific logic
│   ├── qr/                    # CMP qr specific logic
│   ├── recent-transaction/    # CMP recent-transaction specific logic
│   ├── savings/               # CMP payments specific logic
│   ├── settings/              # CMP profile specific logic
│   ├── third-party-transfer/  # CMP qr specific logic
│   ├── transfer-process/      # CMP transfer-process specific logic
│   ├── update-password/       # CMP update-password specific logic
│   └── user-profile/          # CMP user-profiel specific logic
│
├── androidApp/                # Android Application module
├── iosApp/                    # iOS Application module
│
└── shared/                    # Shared Kotlin Multiplatform code

Contributing

We welcome contributions from the community! Please review our contribution guidelines and feel free to submit pull requests or open issues.

How to Contribute

1. Read the project documentation
2. Set up your development environment
3. Choose an issue or feature to work on
4. Follow our commit and coding guidelines
5. Submit a pull request

Join Us on Slack

Mifos boasts an active and vibrant contributor community, Please join us on slack. Once you've joined the mifos slack community, please join the #mifos-mobile channel to engage with mifos-mobile development. If you encounter any difficulties joining our Slack channel, please don't hesitate to open an issue. This will allow us to assist you promptly or send you an invitation.

License

This project is open-source and available under Mozilla Public License Version 2.0 (MPL-2.0).