Skip to content

Commit

Permalink
Readme Updated (#1818)
Browse files Browse the repository at this point in the history
  • Loading branch information
@revanthkumarJ
revanthkumarJ authored Nov 23, 2024
1 parent 2bd59c3 commit 0fa31c0
Show file tree
Hide file tree
Showing 5 changed files with 167 additions and 239 deletions.
231 changes: 36 additions & 195 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@

# Mobile Wallet

Mobile Wallet is an Android-based framework for mobile wallets based on top of <a href='https://github.com/openMF/mobile-wallet/wiki/Fineract-backend'>Fineract</a>. The app follows
Mobile Wallet is an Kotlin Multiplatform (KMP)-based framework for mobile wallets based on top of <a href='https://github.com/openMF/mobile-wallet/wiki/Fineract-backend'>Fineract</a>. The app follows
<a href='https://github.com/openMF/mobile-wallet/wiki/Architecture'>clean architecture</a> and contains a core library module
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.

# Run the project
![Screenshot 2024-10-19 005524](https://github.com/user-attachments/assets/8023c529-1215-4c4b-b212-630f0233223f)
- To run the android-app select the `mifospay-android` run configuration and click run.
- To run the desktop-app select the `mifospay-desktop` run configuration and click run.
- To run the web-app-js select the `mifospay-web-js` run configuration and click run.
## Run the Project

![Screenshot](https://github.com/user-attachments/assets/8023c529-1215-4c4b-b212-630f0233223f)

- **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**.


## KMP Status for modules

Expand Down Expand Up @@ -58,22 +61,24 @@ that can be used as a dependency in any other wallet based project. It is develo
✔️: Successfully compiled
❌: Not functioning, requires further attention

## Notice
⚠️ **Notice:**
We are fully using [Jetpack Compose](https://developer.android.com/jetpack/compose) and are now in the process of converting to support **Kotlin Multiplatform**.

:warning: We are fully committed to implement [Jetpack Compose](https://developer.android.com/jetpack/compose) and moving ourself to support
`kotlin multi-platform`. **If you are sending any PR regarding `XML changes` we will `not` consider at this moment but converting XML to jetpack compose are most welcome.** If you sending any PR regarding logical changes in Activity/Fragment you are most welcome.

Contributions are welcome in the following areas:
- Development and enhancements related to Kotlin Multiplatform.
- Logical changes or improvements in existing Jetpack Compose-based features.

We appreciate your contributions and look forward to collaborating with you!

| Development | Chat |
|--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| ![Mobile-Wallet CI[Master/Dev]](https://github.com/openMF/mobile-wallet/workflows/Mobile-Wallet%20CI%5BMaster/Dev%5D/badge.svg?branch=dev) | [![Join the chat at https://mifos.slack.com/](https://img.shields.io/badge/Join%20Our%20Community-Slack-blue)](https://mifos.slack.com/) |


## 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

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.
Expand All @@ -82,197 +87,41 @@ The issues should be raised via the GitHub issue tracker. For Issue tracker guid

### Branch Policy

We have the following branches :

* **dev**
All the contributions should be pushed to this branch. If you're making a contribution,
you are supposed to make a pull request to _dev_.
Please make sure it passes a build check on Travis.
For development, always pull the **dev** branch, as all contributions and updates are pushed here. Once development is complete, changes are merged into the **master** branch, which contains stable and bug-free code.

It is advisable to clone only the development branch using the following command:

```
git clone -b <branch> <remote_repo>
```
With Git 1.7.10 and later, add --single-branch to prevent fetching of all branches. Example, with development branch:
```
git clone -b dev --single-branch https://github.com/username/mobile-wallet.git`
```
* **master**
The master branch contains all the stable and bug-free working code. The development branch once complete will be merged with this branch.
To know more about branch policies, click [here](https://github.com/openMF/mobile-wallet/wiki/Branch-Policy).

### Demo credentials
Fineract Instance: demo.mifos.io

Username: `venus`

Password: `Venus2023#`

### Development Setup

Before you begin, you should have already downloaded the Android Studio SDK and set it up correctly. You can find a guide on how to do this here: [Setting up Android Studio](http://developer.android.com/sdk/installing/index.html?pkg=studio).
1. **Fork the Git Repository**
Forking the repository is the first step to start contributing. Click on the "Fork" button in the top right corner of the **[Mobile Wallet (Mifos Pay) repository](https://github.com/openMF/mobile-wallet)** to create your own fork.
![image](https://user-images.githubusercontent.com/44428198/254533248-3016c6eb-30b7-492b-91e8-dbbb61f76775.png)
Forking creates a copy of the project under your GitHub account. This enables you to work on changes without affecting the original repository directly.
2. **Clone the Forked Repository**
Once you have forked the repository, you need to clone it to your local development environment. Open a terminal or Git Bash and use the following command:
```bash
git clone https://github.com/yourUsername/mobile-wallet.git
```
Replace **`yourUsername`** with your actual GitHub username. Cloning creates a local copy of the repository on your machine, allowing you to make changes and contributions.
3. **Working Locally on Your Cloned Repository**
After cloning, navigate to the project directory using the terminal or Git Bash.
Before making any changes, create a new branch dedicated to the feature or bug fix you'll be working on:
```bash
git checkout -b "new-branch-name"
```
Ensure that **`new-branch-name`** reflects the purpose of your changes (e.g., **`add-payment-feature`** or **`fix-bug-123`**).
Make the necessary changes to the files to address the issue you're working on. Once you're done, you will be ready to proceed with verifying and committing your changes.
4. **Perform a Gradle Check**
All your pull requests must pass the CI build only then, it will be allowed to merge.
Sometimes, when the build doesn't pass you can use these commands in your local terminal and check for the errors,</br>
**We've commited to use Material3 design in our project. And added lint check for not to use any M2 libraries in our project.</br>**
**And when adding new library, please make sure to follow the naming convention and place in sequential order(A->Z).</br>**
In MacOS, Windows or Linux, you should run the following commands before opening a PR, and make sure to pass all the commands:
**In order to enhance our development process, we have implemented Git hooks in our project.
To install these hooks locally, simply run the command `./gradlew installGitHooks`.
This will ensure that the Git hooks are installed on your local machine.**</br>
* `./gradlew check -p build-logic` this checks build-logic configured properly.</br>
* `./gradlew spotlessApply --no-configuration-cache` an check and apply formatting to any file.</br>
* `./gradlew dependencyGuardBaseline` to generate dependency-guard baseline.</br>
* `./gradlew detekt` to check detekt error.</br>
* `./gradlew testDemoDebug :lint:test :mifospay:lintProdRelease :lint:lint` to check lint and test error.</br>
* `./gradlew build` to build the project.</br>
* `./gradlew updateProdReleaseBadging` to update the badging for the project.</br>
*Or Run the `ci-prebuild.sh` or `ci-prebuild.bat` script to run all the above commands in one go.*
To learn about the development setup, please visit the following link:
[Development Setup Guide](https://github.com/openMF/mobile-wallet/wiki/Development-Setup)

### **Committing Your Changes**

When you've finished making your changes and have tested them locally, it's time to commit your work:
1. **Stage Changes**
Use the following command to stage all changes:
```bash
git add .
```
This adds all modified and new files to the staging area, preparing them for the commit.
2. **Commit Changes**
Commit your changes with a meaningful commit message that describes the purpose of your changes:
```bash
git commit -m "Your commit message goes here"
```
A good commit message is concise and provides enough context about the changes made. Mifos follows its own commit style guidelines that you must follow. Learn more about it [here](https://github.com/openMF/mifos-mobile-cn/blob/master/COMMIT_STYLE.md).
3. **Push Changes**
Push your changes to your forked repository on GitHub:
```bash
git push origin new-branch-name
```
Replace **`new-branch-name`** with the name of the branch you created earlier.
Once you make changes in your local repository, you need to commit them to your GitHub repository.
Don't know how to commit? Click [here](https://github.com/openMF/mobile-wallet/wiki/Committing-Your-Changes) to learn more.

### **Making a Pull Request**

Once your changes are pushed to your forked repository, you can initiate a pull request to merge your changes into the main project:
1. Navigate to the [Mobile Wallet (Mifos Pay) repository](https://github.com/openMF/mobile-wallet) on GitHub.
2. Click on the "Pull Requests" tab and then click "New Pull Request."
![image](https://user-images.githubusercontent.com/44428198/254533309-2df4dca7-aec3-4197-8b86-8b80988e08d7.png)
1. Ensure the base repository is set to "openMF/mobile-wallet" and the base branch is the main development branch `dev`.
2. Set the compare repository to your forked repository and the compare branch to the branch you just created with your changes (e.g., in my case, the head repository was set to “rchtgpt/mobile-wallet” and the comparison branch was `kotlin-migration-common`.
3. Fill out the pull request template, providing a clear description of your changes, why they are necessary, and any relevant information for the reviewers.
4. Click "Create Pull Request" to submit your changes for review.
After pushing your changes to your forked repository, you can create a pull request to propose merging your changes into the main project.
Don't know how to create a pull request? Click [here](https://github.com/openMF/mobile-wallet/wiki/Making-a-Pull-Request) to learn more.

### **Squashing Your Commits**

It is common for pull requests to undergo multiple rounds of review before being merged. To keep the Git history clean and organized, you should always squash your commits before finalizing the merge. Here's how you can do it:
1. Squash your commits:
```bash
git rebase -i HEAD~x
```
Replace **`x`** with the number of commits you want to squash. An interactive rebase will open, allowing you to choose how to combine the commits. Change **`pick`** to **`squash`** (or simply **`s`**) for all but the topmost commit. Save and exit the editor.
2. Amend the commit message if needed.
```bash
git commit --amend
```
3. Force push the changes to your forked repository:
```bash
git push --force origin your-branch-name
```
Please note that force pushing rewrites the Git history, so use it with caution.
To maintain a clean and organized Git history, it is recommended to squash your commits before merging.
Don't know how to squash commits? Click [here](https://github.com/openMF/mobile-wallet/wiki/Squashing-Your-Commits) to learn more.

### **Solving Merge Conflicts**

In some cases, your pull request might encounter merge conflicts when the changes cannot be automatically merged with the main branch. To resolve merge conflicts:
1. Update your local branch with the latest changes from the main repository:
```bash
git fetch upstream
git checkout your-branch-name
git rebase upstream/master
```
2. Git will pause when encountering conflicts. Open the affected files, resolve the conflicts manually, and save the changes.
3. After resolving all conflicts, stage the changes and continue with the rebase:
```bash
git add .
git rebase --continue
```
4. Finally, force push the changes to your forked repository:
```
git push --force origin your-branch-name
```
Your pull request will be updated with the resolved conflicts, and the reviewers can proceed with the review process. Again, don’t forget to squash your commits.
Sometimes, your pull request may encounter merge conflicts that need to be resolved manually.
Don't know how to resolve merge conflicts? Click [here](https://github.com/openMF/mobile-wallet/wiki/Solving-Merge-Conflicts) to learn more.

### 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!
Expand All @@ -288,21 +137,15 @@ To get the latest apk fom the Github actions artifacts, follow these steps:

## Wiki

https://github.com/openMF/mobile-wallet/wiki
To know more about the project, visit our [Wiki](https://github.com/openMF/mobile-wallet/wiki).

## Screenshots
<p>
<img src="https://user-images.githubusercontent.com/37406965/51085243-86f2cd00-175c-11e9-9f5e-8a2324cfda4a.jpg" width="288" height="500" />
<img src="https://user-images.githubusercontent.com/37406965/51085245-8823fa00-175c-11e9-949a-c5292037b970.jpg" width="288" height="500" />
<img src="https://user-images.githubusercontent.com/37406965/51085246-89552700-175c-11e9-9a5b-5a85ecb5bfae.jpg" width="288" height="500" />
</p>
<p>
Click <a href= "https://github.com/openMF/mobile-wallet/blob/dev/Screenshot.md">here </a> for more screenshots
</p>
| OS | Image | More Images |
|:-----------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------:|
| Android | <img src="https://github.com/user-attachments/assets/2753a54c-201d-4570-b363-46c930793d37" width="120" height="210" style="margin-right:10px;"/> <img src="https://github.com/user-attachments/assets/8d75922e-fd9f-42c1-8c94-2fdfc69658a9" width="120" height="210" style="margin-right:10px;"/> <img src="https://github.com/user-attachments/assets/ce6c4523-292a-46d9-b38c-b0a6b9aba052" width="120" height="210"/> | <a href= "https://github.com/openMF/mobile-wallet/blob/dev/docs/readmes/Android.md">Load More</a> |
| iOS | <img src="https://github.com/user-attachments/assets/43dd37bf-93a7-4905-a28b-eb60e1ead2e3" width="120" height="210" style="margin-right:10px;"/> <img src="https://github.com/user-attachments/assets/2753a54c-201d-4570-b363-46c930793d37" width="120" height="210" style="margin-right:10px;"/> <img src="https://github.com/user-attachments/assets/42ec8984-7224-4aab-84f3-2a8f42022186" width="120" height="210"/> | <a href= "https://github.com/openMF/mobile-wallet/blob/dev/docs/readmes/Android.md">Load More</a> |
| Windows | <img src="https://github.com/user-attachments/assets/ee4ed3ce-ea15-42f3-8c2a-0f55dcff81af" width="200" style="margin-right:10px;"/> <img src="https://github.com/user-attachments/assets/edf0eb72-9cba-401e-8732-7d272fdaf125" width="200"/> | <a href= "https://github.com/openMF/mobile-wallet/blob/dev/docs/readmes/Windows.md">Load More</a> |
| Linux | <img src="https://github.com/user-attachments/assets/72b373df-b247-4554-94ab-373fc46e7599" width="200" style="margin-right:10px;"/> <img src="https://github.com/user-attachments/assets/ce4fa873-c0ee-46c8-8517-82bbf30f65c4" width="200"/> | <a href= "https://github.com/openMF/mobile-wallet/blob/dev/docs/readmes/Linux.md">Load More</a> |

## Contributors

Expand All @@ -311,5 +154,3 @@ Special thanks to the incredible code contributors who continue to drive this pr
<a href="https://github.com/openMF/mobile-wallet/graphs/contributors">
<img src="https://contrib.rocks/image?repo=openMF/mobile-wallet" />
</a>
Loading

0 comments on commit 0fa31c0

Please sign in to comment.