Skip to content
Sk Niyaj Ali edited this page Dec 26, 2024 · 7 revisions

Frame 12 (6)

Welcome to the Mobile Wallet Project Wiki

The Mobile Wallet project is a kotlin multiplatform application designed to provide flexible and comprehensive digital wallet functionality across multiple platforms.

Kotlin Kotlin Multiplatform Compose Multiplatform badge-android badge-ios badge-desktop badge-js PR Checks Join the chat at https://mifos.slack.com/

Project Overview

Mobile Wallet is an open-source digital financial solution designed to provide a comprehensive, cross-platform mobile banking and payment application. Developed under the Mifos Initiative, this project aims to create a flexible and accessible digital wallet platform using Apache Fineract API.

Quick Navigation

Getting Started

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

Development Guidelines

Technical Documentation

Project Modules

project-root/ Mobile Wallet

├── 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
│   ├── accounts/          # CMP account specific module
│   ├── auth/              # CMP auth specific module
│   ├── editpassword/      # CMP editpassword specific logic
│   ├── faq/               # CMP faq specific logic
│   ├── finance/           # CMP finance specific logic
│   ├── history/           # CMP history specific logic
│   ├── home/              # CMP home specific logic
│   ├── invoices/          # CMP invoices specific logic
│   ├── kyc/               # CMP kyc specific logic
│   ├── make-transfer/     # CMP make-transfer specific logic
│   ├── merchants/         # CMP merchnats specific logic
│   ├── notification/      # CMP notification specific logic
│   ├── payments/          # CMP payments specific logic
│   ├── profile/           # CMP profile specific logic
│   ├── qr/                # CMP qr specific logic
│   ├── receipt/           # CMP receipt specific logic
│   ├── request-money/     # CMP request-money specific logic
│   ├── savedcards/        # CMP saved-cards specific logic
│   ├── send-money/        # CMP send-money specific logic
│   ├── settings/          # CMP settings specific logic
│   └── upi-setup/         # CMP upi-setup specific logic

├── mifospay-android/      # Android Application module
├── mifospay-ios/          # iOS Application module
├── mifospay-desktop/      # Desktop application module
├── mifospay-web/          # Web application module

├── mifospay-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 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.

Slack Jira

License

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

Demo credentials

  • Fineract Instance: venus.mifos.io
  • username: venus
  • password: Venus2023#
Clone this wiki locally