Home - openMF/mifos-mobile GitHub Wiki

Welcome to Mifos Mobile Wiki

Welcome to the Mifos Mobile wiki. This comprehensive document outlines how to contribute effectively to improve the Self Service Android Application, from reporting issues to submitting code changes. Mifos Mobile is An Android Application built on top of the MifosX Self-Service platform for end-user customers to view/transact on the accounts and loans they hold. Data visible to customers will be a sub-set of what staff can see. This is a native Android Application written in Kotlin.

Kotlin Kotlin Multiplatform Android

PRs Welcome GitHub license GitHub release GitHub issues

Workflow for master/development branches Slack Jira

Code of Conduct

Mifos has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Note

We're moving to Jira for issue tracking. Please use Jira for issue tracking. And Join our slack channel mifos-mobile to discuss all things about Mifos Mobile development. and do not cross post your messages in multiple channels. ask your question in the appropriate channel.

Quick Navigation

Getting Started

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

Development Guidelines

Technical Documentation

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

Thank you for being so interested in contributing to the Mifos Mobile project by Mifos! We welcome all contributions and encourage you to follow these guidelines to ensure a smooth and efficient collaboration process.

To get started, please refer to the Contribution Guide for detailed instructions on how to contribute to the project.

The Open Source Guides website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:

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.

Slack Jira

License

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

πŸ”—Links

⚠️ **GitHub.com Fallback** ⚠️