Skip to content

Commit 4a22b6e

Browse files
niyajaliniyajali
authored
chore: Updated Readme (openMF#1834)
* chore: Updated Readme * Updated Images
1 parent 6e1c50f commit 4a22b6e

File tree

3 files changed

+58
-122
lines changed

3 files changed

+58
-122
lines changed

‎.run/mifos-ios.run.xml

-7
This file was deleted.

‎.run/mifospay-ios.run.xml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<component name="ProjectRunConfigurationManager">
2+
<configuration default="false" name="mifospay-ios" type="KmmRunConfiguration" factoryName="iOS Application" CONFIG_VERSION="1" XCODE_PROJECT="$PROJECT_DIR$/mifospay-ios/iosApp.xcodeproj">
3+
<method v="2">
4+
<option name="com.jetbrains.kmm.ios.BuildIOSAppTask" enabled="true" />
5+
</method>
6+
</configuration>
7+
</component>

‎README.md

+51-115
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,51 @@
1-
![Kotlin](https://img.shields.io/badge/Kotlin-7f52ff?style=flat-square&logo=kotlin&logoColor=white)
1+
![Frame 9 (2)](https://github.com/user-attachments/assets/4d53ff45-5348-41a5-98cd-a3dbabb52703)
2+
3+
<div align="center">
4+
5+
# Mobile Wallet
6+
Mobile Wallet is a Kotlin Multiplatform(KMP) based project built on top of Apache <a href='https://github.com/openMF/mobile-wallet/wiki/Fineract-backend'>Fineract</a> API.
7+
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.
8+
9+
![Kotlin](https://img.shields.io/badge/Kotlin-7f52ff?style=flat-square&logo=kotlin&logoColor=white)
210
![Kotlin Multiplatform](https://img.shields.io/badge/Kotlin%20Multiplatform-4c8d3f?style=flat-square&logo=kotlin&logoColor=white)
311
![Compose Multiplatform](https://img.shields.io/badge/Jetpack%20Compose%20Multiplatform-000000?style=flat-square&logo=android&logoColor=white)
4-
[![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)
5-
[![Join the chat at https://mifos.slack.com/](https://img.shields.io/badge/Join%20Our%20Community-Slack-blue)](https://mifos.slack.com/)
612

7-
<img height='175' src="https://user-images.githubusercontent.com/44283521/78983673-455cf780-7b42-11ea-849e-ecd2009dd562.png" align="left" hspace="1" vspace="1">
13+
![badge-android](http://img.shields.io/badge/platform-android-6EDB8D.svg?style=flat)
14+
![badge-ios](http://img.shields.io/badge/platform-ios-CDCDCD.svg?style=flat)
15+
![badge-desktop](http://img.shields.io/badge/platform-desktop-DB413D.svg?style=flat)
16+
![badge-js](http://img.shields.io/badge/platform-web-FDD835.svg?style=flat)
817

9-
# Mobile Wallet
10-
Mobile Wallet is a Kotlin Multiplatform (KMP)-based application for mobile wallets built on top of <a href='https://github.com/openMF/mobile-wallet/wiki/Fineract-backend'>Fineract</a>. The app follows
11-
<a href='https://github.com/openMF/mobile-wallet/wiki/Architecture'>clean architecture</a> and contains a core library module
12-
that can be used as a dependency in any other wallet-based project. It is developed at <a href='https://mifos.org/'>MIFOS</a> together with a global community.
1318

14-
## Run the Project
15-
![Screenshot](https://github.com/user-attachments/assets/8023c529-1215-4c4b-b212-630f0233223f)
19+
[![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)
20+
[![Join the chat at https://mifos.slack.com/](https://img.shields.io/badge/Join%20Our%20Community-Slack-blue)](https://mifos.slack.com/)
21+
22+
</div>
23+
24+
<div align="center"><a name="readme-top"></a></div>
25+
26+
### Run the Project
27+
![Screenshot (154)](https://github.com/user-attachments/assets/761063ed-83f8-4443-b58f-2b68a4c74c5d)
28+
1629
- **Android App**: Select the `mifospay-android` run configuration and click **Run**.
1730
- **Desktop App**: Select the `mifospay-desktop` run configuration and click **Run**.
18-
- **Web App (JavaScript)**: Select the `mifospay-web-js` run configuration and click **Run**.
31+
- **Web App (JavaScript)**: Select the `mifospasy-web-js` run configuration and click **Run**.
32+
- **iOS App**: Select the `mifospay-ios` run configuration and click **Run**.
33+
34+
> \[!Important]
35+
> To run the iOS app, you need to have a macOS device with Xcode installed.
36+
37+
> \[!Note]
38+
> Currently, the `mifospay-web-wasm` app is not working as expected. We are working on it and will be available soon.
1939
2040
### Demo Credentials
21-
- **Fineract Instance**: demo.mifos.io
41+
- **Fineract Instance**: `venus.mifos.io`
2242
- **Username**: `venus`
2343
- **Password**: `Venus2023#`
2444

25-
26-
## KMP Status for modules
27-
28-
| Module | Progress | Desktop supported | Android supported | iOS supported | Web supported(JS) | Web supported(WASM-JS) |
29-
|-------------------------------|----------|-------------------|-------------------|---------------|-------------------|-------------------------|
30-
| mifospay-android | Done | ✅ | ✅ | ❔ | ✅ | ❔ |
31-
| mifospay-desktop | Done | ✅ | ✅ | ❔ | ✅ | ❔ |
32-
| mifospay-web | Done | ✅ | ✅ | ❔ | ✅ | ❔ |
33-
| mifospay-ios | NO OP | ❌ | ❌ | ❌ | ❌ | ❌ |
34-
| :core:analytics | Done | ❌ | ✔️ | ❔ | ❌ | ❔ |
35-
| :core:common | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
36-
| :core:data | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
37-
| :core:datastore | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
38-
| :core:datastore-proto | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
39-
| :core:designsystem | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
40-
| :core:domain | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
41-
| :core:model | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
42-
| :core:network | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
43-
| :core:ui | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
44-
| :feature:auth | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
45-
| :feature:editpassword | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
46-
| :feature:faq | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
47-
| :feature:history | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
48-
| :feature:home | Done | ✅ | ✅ | ❔ | ✅ | ❌ |
49-
| :feature:profile | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
50-
| :feature:settings | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
51-
| :feature:payments | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
52-
| :feature:finance | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
53-
| :feature:account | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
54-
| :feature:invoices | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
55-
| :feature:kyc | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
56-
| :feature:make-transfer | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
57-
| :feature:merchants | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
58-
| :feature:notification | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
59-
| :feature:qr | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
60-
| :feature:receipt | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
61-
| :feature:request-money | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
62-
| :feature:saved-cards | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
63-
| :feature:send-money | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
64-
| :feature:standing-instruction | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
65-
| :feature:upi-setup | Done | ✅ | ✅ | ❔ | ✅ | ✅ |
66-
67-
✅: Functioning properly
68-
❔: Not yet tested, but expected to work
69-
✔️: Successfully compiled
70-
❌: Not functioning, requires further attention
71-
72-
73-
The project fully utilizes [Jetpack Compose](https://developer.android.com/jetpack/compose) with complete support for **Kotlin Multiplatform**.
74-
75-
We invite contributions in the following areas:
76-
- Development of new features and enhancements using Kotlin Multiplatform.
77-
- Improvements and refinements to existing Jetpack Compose-based functionalities.
78-
79-
We appreciate your contributions and look forward to collaborating with you!
80-
81-
82-
## Join Us on Slack
45+
### Join Us on Slack
8346
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.
8447

85-
## How to Contribute
48+
### How to Contribute
8649
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.
8750

8851
The issues should be raised via the GitHub issue tracker. For Issue tracker guidelines please click <a href="https://github.com/openMF/mobile-wallet/blob/master/.github/CONTRIBUTING.md#issue-tracker">here</a>. All fixes should be proposed via pull requests. For pull request guidelines please click <a href="https://github.com/openMF/mobile-wallet/blob/master/.github/CONTRIBUTING.md#pull-requests">here</a>. For commit style guidelines please click <a href="https://github.com/openMF/mobile-wallet/wiki/Commit-style-guide">here</a>.
@@ -92,72 +55,45 @@ For development purposes, always pull from the **dev** branch, as all contributi
9255

9356
For more detailed information about the branch policies, please refer to the [Branch Policy](https://github.com/openMF/mobile-wallet/wiki/Branch-Policy).
9457

95-
9658
### Development Setup
9759
Please refer to the [Development Setup Guide](https://github.com/openMF/mobile-wallet/wiki/Development-Setup) for detailed instructions on configuring the development environment.
9860

99-
### **Committing Your Changes**
100-
After making changes in your local repository, you will need to commit them to your GitHub repository.
61+
### Committing Your Changes
62+
After making changes in your local repository, you will need to commit them to your GitHub repository.
10163
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.
10264

103-
### **Making a Pull Request**
65+
### Making a Pull Request
10466
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.
10567
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.
10668

107-
### **Squashing Your Commits**
69+
### Squashing Your Commits
10870
To ensure a clean and organized Git history, contributors are encouraged to squash their commits before merging.
10971
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.
11072

111-
### **Resolving Merge Conflicts**
73+
### Resolving Merge Conflicts
11274
Occasionally, merge conflicts may arise when your pull request is being reviewed. These conflicts need to be resolved manually.
11375
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.
11476

11577
### Conclusion
11678
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!
11779

118-
## Instructions to Get the Latest APK
80+
### Instructions to Get the Latest APK
11981

120-
To download the latest APK from the GitHub Actions artifacts, follow these steps:
82+
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.
12183

122-
### Step 1: Access the Actions Tab
123-
- 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.
84+
### Wiki
85+
To know more about the project details and architecture guidelines, visit our [Wiki](https://github.com/openMF/mobile-wallet/wiki).
12486

125-
### Step 2: Select the Latest Workflow
126-
- Click on the most recent workflow from the workflows list.
127-
128-
### Step 3: Locate the Artifacts Section
129-
- Scroll down to the **Artifacts** section, where you will find:
130-
- **Android APKs**
131-
- **Linux-App**
132-
- **MacOS-App**
133-
- **Windows-Apps**
134-
- Download all the available zip files.
135-
136-
![Artifacts Section](https://github.com/user-attachments/assets/ab7783ff-3834-4be2-9ce8-6342746b22a2)
137-
138-
### Step 4: Extract the Files
139-
- After downloading the files, extract the zip archives to your preferred location.
140-
141-
### Step 5: Install the Application
142-
- Open the extracted files and install the application on your device.
143-
144-
145-
## Wiki
146-
To know more about the project, visit our [Wiki](https://github.com/openMF/mobile-wallet/wiki).
147-
148-
## Screenshots
149-
150-
| OS | Image | More Images |
151-
|:-----------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------:|
152-
| Android | <img src="https://github.com/user-attachments/assets/2753a54c-201d-4570-b363-46c930793d37" style="width:30%;"/> <img src="https://github.com/user-attachments/assets/8d75922e-fd9f-42c1-8c94-2fdfc69658a9" style="width:30%;"/> <img src="https://github.com/user-attachments/assets/ce6c4523-292a-46d9-b38c-b0a6b9aba052" style="width:30%;"/> | <a href= "https://github.com/openMF/mobile-wallet/blob/dev/docs/readmes/Android.md">Load More</a> |
153-
| iOS | <img src="https://github.com/user-attachments/assets/43dd37bf-93a7-4905-a28b-eb60e1ead2e3" style="width:30%;"/> <img src="https://github.com/user-attachments/assets/2753a54c-201d-4570-b363-46c930793d37" style="width:30%;"/> <img src="https://github.com/user-attachments/assets/42ec8984-7224-4aab-84f3-2a8f42022186" style="width:30%;"/> | <a href= "https://github.com/openMF/mobile-wallet/blob/dev/docs/readmes/Android.md">Load More</a> |
154-
| Windows | <img src="https://github.com/user-attachments/assets/ee4ed3ce-ea15-42f3-8c2a-0f55dcff81af" style="width:45%;"/> <img src="https://github.com/user-attachments/assets/edf0eb72-9cba-401e-8732-7d272fdaf125" style="width:45%;"/> | <a href= "https://github.com/openMF/mobile-wallet/blob/dev/docs/readmes/Windows.md">Load More</a> |
155-
| Linux | <img src="https://github.com/user-attachments/assets/72b373df-b247-4554-94ab-373fc46e7599" style="width:45%;"/> <img src="https://github.com/user-attachments/assets/ce4fa873-c0ee-46c8-8517-82bbf30f65c4" style="width:45%;"/> | <a href= "https://github.com/openMF/mobile-wallet/blob/dev/docs/readmes/Linux.md">Load More</a> |
156-
157-
## Contributors
87+
### Contributors
15888

15989
Special thanks to the incredible code contributors who continue to drive this project forward.
16090

16191
<a href="https://github.com/openMF/mobile-wallet/graphs/contributors">
162-
<img src="https://contrib.rocks/image?repo=openMF/mobile-wallet" />
92+
<img src="https://contrib.rocks/image?repo=openMF/mobile-wallet" alt="mobile wallet contributors"/>
16393
</a>
94+
95+
<div align="right">
96+
97+
[![Back To Top](https://img.shields.io/badge/Back%20To%20Top-Blue?style=flat)](#readme-top)
98+
99+
</div>

0 commit comments

Comments
 (0)