- Kotlin 95.1%
- Java 4.7%
- Dockerfile 0.2%
|
|
||
|---|---|---|
| .github | ||
| .run | ||
| build-logic | ||
| cmp-android | ||
| cmp-desktop | ||
| cmp-ios | ||
| cmp-shared | ||
| cmp-web | ||
| config/detekt | ||
| core | ||
| core-base | ||
| docs | ||
| fastlane | ||
| fastlane-config | ||
| feature | ||
| gradle | ||
| keystores | ||
| kotlin-js-store | ||
| libs/mifos-passcode | ||
| scripts | ||
| spotless | ||
| .editorconfig | ||
| .gitignore | ||
| .ruby-version | ||
| build.gradle.kts | ||
| ci-prepush.bat | ||
| ci-prepush.sh | ||
| CODE_OF_CONDUCT.md | ||
| compose_compiler_config.conf | ||
| Dockerfile | ||
| Gemfile | ||
| Gemfile.lock | ||
| generateModuleGraphs.sh | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| keystore-manager.sh | ||
| LICENSE | ||
| README.md | ||
| secrets.env.template | ||
| selfservice-collection.postman.json | ||
| settings.gradle.kts | ||
| sync-dirs.sh | ||
Mifos Pay
Mifos Pay 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.
[!Note] We're moving towards to Jira for issue tracking. Please use Jira for issue tracking. And Join our slack community channel
mifos-payto discuss all things about Mifos Pay development. Please keep discussions focused and avoid cross-posting across channels. Please join our daily Mobile Stand-Up on Zoom.
Run the Project
- Android App: Select the
cmp-androidrun configuration and click Run. - Desktop App: Select the
cmp-desktoprun configuration and click Run. - Web App (JavaScript): Select the
cmp-web-jsrun configuration and click Run. - iOS App: Select the
cmp-iosrun configuration and click Run.
[!Important] To run the iOS app, you must have a macOS device with Xcode installed. Currently, the
cmp-web-wasmapp is not working as expected. We are working on it and it will be available soon.
Demo Credentials
Access the Mifos Pay demo credentials on our Jira Wiki page.
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-pay channel to engage with mifos-pay 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.
How to Contribute
Thank you for your interest in contributing to the Mifos Pay project by Mifos! We welcome all contributions and encourage you to follow these guidelines to ensure a smooth and efficient collaboration process.
- Sign the Contribution License Agreement.
- Always follow the code of conduct - this is important to us. We are proud to be open, tolerant and providing a positive environment.
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.
Branch Policy
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.
Development Setup
Please refer to the Development Setup Guide for detailed instructions on configuring the development environment.
Committing Your Changes
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.
Squashing Your Commits
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.
Resolving Merge Conflicts
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.
Conclusion
By following these contribution guidelines, you're all set to start contributing to the Mifos Pay project. We appreciate your efforts and look forward to your valuable contributions. Happy coding!
Instructions to Get the Latest APK
To download the latest APK navigate to the latest release here, and download the APK file from the assets section.
Wiki
To know more about the project details and architecture guidelines, visit our Wiki.
Contributors
Special thanks to the incredible code contributors who continue to drive this project forward.
