From 4a22b6e65054d7278816ca15a5d8fd2492942b12 Mon Sep 17 00:00:00 2001 From: Sk Niyaj Ali Date: Wed, 11 Dec 2024 20:16:15 +0530 Subject: [PATCH] chore: Updated Readme (#1834) * chore: Updated Readme * Updated Images --- .run/mifos-ios.run.xml | 7 -- .run/mifospay-ios.run.xml | 7 ++ README.md | 166 ++++++++++++-------------------------- 3 files changed, 58 insertions(+), 122 deletions(-) delete mode 100644 .run/mifos-ios.run.xml create mode 100644 .run/mifospay-ios.run.xml diff --git a/.run/mifos-ios.run.xml b/.run/mifos-ios.run.xml deleted file mode 100644 index 85ce3840b..000000000 --- a/.run/mifos-ios.run.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.run/mifospay-ios.run.xml b/.run/mifospay-ios.run.xml new file mode 100644 index 000000000..8b3ac7d5d --- /dev/null +++ b/.run/mifospay-ios.run.xml @@ -0,0 +1,7 @@ + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index e207debf7..857bd80be 100644 --- a/README.md +++ b/README.md @@ -1,88 +1,51 @@ -![Kotlin](https://img.shields.io/badge/Kotlin-7f52ff?style=flat-square&logo=kotlin&logoColor=white) +![Frame 9 (2)](https://github.com/user-attachments/assets/4d53ff45-5348-41a5-98cd-a3dbabb52703) + +
+ +# Mobile Wallet +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. + +![Kotlin](https://img.shields.io/badge/Kotlin-7f52ff?style=flat-square&logo=kotlin&logoColor=white) ![Kotlin Multiplatform](https://img.shields.io/badge/Kotlin%20Multiplatform-4c8d3f?style=flat-square&logo=kotlin&logoColor=white) ![Compose Multiplatform](https://img.shields.io/badge/Jetpack%20Compose%20Multiplatform-000000?style=flat-square&logo=android&logoColor=white) -[![Mobile-Wallet CI[Master/Dev]](https://github.com/openMF/mobile-wallet/actions/workflows/master_dev_ci.yml/badge.svg?branch=dev)](https://github.com/openMF/mobile-wallet/actions/workflows/master_dev_ci.yml) - [![Join the chat at https://mifos.slack.com/](https://img.shields.io/badge/Join%20Our%20Community-Slack-blue)](https://mifos.slack.com/) - +![badge-android](http://img.shields.io/badge/platform-android-6EDB8D.svg?style=flat) +![badge-ios](http://img.shields.io/badge/platform-ios-CDCDCD.svg?style=flat) +![badge-desktop](http://img.shields.io/badge/platform-desktop-DB413D.svg?style=flat) +![badge-js](http://img.shields.io/badge/platform-web-FDD835.svg?style=flat) -# Mobile Wallet -Mobile Wallet is a Kotlin Multiplatform (KMP)-based application for mobile wallets built on top of Fineract. The app follows -clean architecture and contains a core library module -that can be used as a dependency in any other wallet-based project. It is developed at MIFOS together with a global community. -## Run the Project -![Screenshot](https://github.com/user-attachments/assets/8023c529-1215-4c4b-b212-630f0233223f) +[![PR Checks](https://github.com/openMF/mobile-wallet/actions/workflows/pr-check.yml/badge.svg)](https://github.com/openMF/mobile-wallet/actions/workflows/pr-check.yml) +[![Join the chat at https://mifos.slack.com/](https://img.shields.io/badge/Join%20Our%20Community-Slack-blue)](https://mifos.slack.com/) + +
+ +
+ +### Run the Project +![Screenshot (154)](https://github.com/user-attachments/assets/761063ed-83f8-4443-b58f-2b68a4c74c5d) + - **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 `mifospay-web-js` 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 need to have a macOS device with Xcode installed. + +> \[!Note] +> Currently, the `mifospay-web-wasm` app is not working as expected. We are working on it and will be available soon. ### Demo Credentials -- **Fineract Instance**: demo.mifos.io +- **Fineract Instance**: `venus.mifos.io` - **Username**: `venus` - **Password**: `Venus2023#` - -## KMP Status for modules - -| Module | Progress | Desktop supported | Android supported | iOS supported | Web supported(JS) | Web supported(WASM-JS) | -|-------------------------------|----------|-------------------|-------------------|---------------|-------------------|-------------------------| -| mifospay-android | Done | ✅ | ✅ | ❔ | ✅ | ❔ | -| mifospay-desktop | Done | ✅ | ✅ | ❔ | ✅ | ❔ | -| mifospay-web | Done | ✅ | ✅ | ❔ | ✅ | ❔ | -| mifospay-ios | NO OP | ❌ | ❌ | ❌ | ❌ | ❌ | -| :core:analytics | Done | ❌ | ✔️ | ❔ | ❌ | ❔ | -| :core:common | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :core:data | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :core:datastore | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :core:datastore-proto | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :core:designsystem | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :core:domain | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :core:model | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :core:network | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :core:ui | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:auth | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:editpassword | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:faq | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:history | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:home | Done | ✅ | ✅ | ❔ | ✅ | ❌ | -| :feature:profile | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:settings | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:payments | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:finance | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:account | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:invoices | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:kyc | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:make-transfer | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:merchants | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:notification | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:qr | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:receipt | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:request-money | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:saved-cards | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:send-money | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:standing-instruction | Done | ✅ | ✅ | ❔ | ✅ | ✅ | -| :feature:upi-setup | Done | ✅ | ✅ | ❔ | ✅ | ✅ | - -✅: Functioning properly -❔: Not yet tested, but expected to work -✔️: Successfully compiled -❌: Not functioning, requires further attention - - -The project fully utilizes [Jetpack Compose](https://developer.android.com/jetpack/compose) with complete support for **Kotlin Multiplatform**. - -We invite contributions in the following areas: -- Development of new features and enhancements using Kotlin Multiplatform. -- Improvements and refinements to existing Jetpack Compose-based functionalities. - -We appreciate your contributions and look forward to collaborating with you! - - -## Join Us on Slack +### Join Us on Slack Mifos boasts an active and vibrant contributor community, Please join us on [slack](https://join.slack.com/t/mifos/shared_invite/zt-2f4nr6tk3-ZJlHMi1lc0R19FFEHxdvng). 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. -## How to Contribute +### How to Contribute 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. @@ -92,72 +55,45 @@ For development purposes, always pull from the **dev** branch, as all contributi For more detailed information about the branch policies, please refer to the [Branch Policy](https://github.com/openMF/mobile-wallet/wiki/Branch-Policy). - ### Development Setup Please refer to the [Development Setup Guide](https://github.com/openMF/mobile-wallet/wiki/Development-Setup) 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. +### 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](https://github.com/openMF/mobile-wallet/wiki/Committing-Your-Changes) guide. -### **Making a Pull Request** +### Making a Pull Request Once your changes have been pushed to your forked repository, you can create a pull request to propose integrating your updates into the main project. For guidance on creating a pull request, please visit the [Making a Pull Request](https://github.com/openMF/mobile-wallet/wiki/Making-a-Pull-Request) guide. -### **Squashing Your Commits** +### 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](https://github.com/openMF/mobile-wallet/wiki/Squashing-Your-Commits) guide. -### **Resolving Merge Conflicts** +### 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](https://github.com/openMF/mobile-wallet/wiki/Solving-Merge-Conflicts) guide. ### Conclusion 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! -## Instructions to Get the Latest APK +### Instructions to Get the Latest APK -To download the latest APK from the GitHub Actions artifacts, follow these steps: +To download the latest APK navigate to the latest release [here](https://github.com/openMF/mobile-wallet/releases), and download the APK file from the assets section. -### Step 1: Access the Actions Tab -- Navigate to the [Actions Tab](https://github.com/openMF/mobile-wallet/actions?query=workflow%3A%22Mobile-Wallet+CI%5BMaster%2FDev%5D%22+event%3Apush) of this repository. +### Wiki +To know more about the project details and architecture guidelines, visit our [Wiki](https://github.com/openMF/mobile-wallet/wiki). -### Step 2: Select the Latest Workflow -- Click on the most recent workflow from the workflows list. - -### Step 3: Locate the Artifacts Section -- Scroll down to the **Artifacts** section, where you will find: - - **Android APKs** - - **Linux-App** - - **MacOS-App** - - **Windows-Apps** -- Download all the available zip files. - - ![Artifacts Section](https://github.com/user-attachments/assets/ab7783ff-3834-4be2-9ce8-6342746b22a2) - -### Step 4: Extract the Files -- After downloading the files, extract the zip archives to your preferred location. - -### Step 5: Install the Application -- Open the extracted files and install the application on your device. - - -## Wiki -To know more about the project, visit our [Wiki](https://github.com/openMF/mobile-wallet/wiki). - -## Screenshots - -| OS | Image | More Images | -|:-----------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------:| -| Android | | Load More | -| iOS | | Load More | -| Windows | | Load More | -| Linux | | Load More | - -## Contributors +### Contributors Special thanks to the incredible code contributors who continue to drive this project forward. - + mobile wallet contributors + +
+ +[![Back To Top](https://img.shields.io/badge/Back%20To%20Top-Blue?style=flat)](#readme-top) + +