Mobile Wallet is a Kotlin Multiplatform(KMP) based project built on top of Apache Fineract API. Following recommended architecture and design patterns, the application is developed using the latest technologies and frameworks/libraries, such as Jetpack Compose, Ktor, Ktorfit, and Koin. It is designed to be cross-platform, supporting Android, iOS, Desktop, and Web platforms.
- Android App: Select the
mifospay-android
run configuration and click Run. - Desktop App: Select the
mifospay-desktop
run configuration and click Run. - Web App (JavaScript): Select the
mifospasy-web-js
run configuration and click Run. - iOS App: Select the
mifospay-ios
run configuration and click Run.
Important
To run the iOS app, you must have a macOS device with Xcode installed. Currently, the mifospay-web-wasm
app is not working as expected. We are working on it and it will be available soon.
- Fineract Instance:
venus.mifos.io
- Username:
venus
- Password:
Venus2023#
Mifos boasts an active and vibrant contributor community, Please join us on slack. Once you've joined the mifos slack community, please join the #mobile-wallet
channel to engage with mobile-wallet 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.
Thank you for your interest in contributing to the Mobile Wallet project by Mifos! We welcome all contributions and encourage you to follow these guidelines to ensure a smooth and efficient collaboration process.
The issues should be raised via the GitHub issue tracker. For Issue tracker guidelines please click here. All fixes should be proposed via pull requests. For pull request guidelines please click here. For commit style guidelines please click here.
For development purposes, always pull from the dev branch, as all contributions and updates are merged into this branch. Upon completion of development, changes are subsequently merged into the master branch, which represents the stable and bug-free version of the code.
Please refer to the Development Setup Guide for detailed instructions on configuring the development environment.
After making changes in your local repository, you will need to commit them to your GitHub repository. If you are unfamiliar with the process of committing changes, please refer to the Committing Your Changes guide.
To ensure a clean and organized Git history, contributors are encouraged to squash their commits before merging.
Instructions on how to squash commits can be found in the Squashing Your Commits guide.
Occasionally, merge conflicts may arise when your pull request is being reviewed. These conflicts need to be resolved manually.
To learn how to resolve merge conflicts, please refer to the Solving Merge Conflicts guide.
By following these contribution guidelines, you're all set to start contributing to the Mobile Wallet (Mifos Pay) project. We appreciate your efforts and look forward to your valuable contributions. Happy coding!
To download the latest APK navigate to the latest release here, and download the APK file from the assets section.
To know more about the project details and architecture guidelines, visit our Wiki.
Special thanks to the incredible code contributors who continue to drive this project forward.