diff --git a/README.md b/README.md index 0b756204ea2..34b44d1f912 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,75 @@ - +![cover](https://user-images.githubusercontent.com/94394661/278370464-4248f4eb-3601-42da-af40-0cc1531661ff.png) -# Android Client for MifosX -This is an Android Application built on top of the [MifosX](https://mifosforge.jira.com/wiki/spaces/MIFOSX/overview) platform and written in Java and Kotlin. It is based on Mifos X - a robust core banking platform that is developed for field officers using which they process transactions, keep track of their client’s data, center records, group details, different types of accounts (loan, savings and recurring) of the client, run reports of clients, etc. Its sole purpose is to make field operations easier and effortless. This application also provides an offline feature that allows officers to connect with clients and provide them financial support in remote areas as well. -### Status + -[![Join the chat at https://gitter.im/openMF/android-client](https://badges.gitter.im/openMF/android-client.svg)](https://gitter.im/openMF/android-client?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -[![Build Status](https://travis-ci.org/openMF/android-client.svg?branch=master)](https://travis-ci.org/openMF/android-client) -[![Coverage Status](https://coveralls.io/repos/github/openMF/android-client/badge.svg?branch=master)](https://coveralls.io/github/openMF/android-client?branch=master) +# Android Client for MifosX +This is an Android Application built on top of the [MifosX](https://mifosforge.jira.com/wiki/spaces/MIFOSX/overview) platform and written in Kotlin. It is based on Mifos X - a robust core banking platform that is developed for field officers using which they process transactions, keep track of their client’s data, center records, group details, different types of accounts (loan, savings and recurring) of the client, run reports of clients, etc. Its sole purpose is to make field operations easier and effortless. This application also provides an offline feature that allows officers to connect with clients and provide them financial support in remote areas as well. +### Features -Some **features** that are available in the app are: -- Search of Clients, Client Details Viewing -- Creating new Clients, Groups, and Centers -- Savings Accounts and Loan Accounts Viewing -- Savings Account Transactions (Withdrawal & Deposit) -- Loan Accounts (Approval, Disbursal, Repayments etc.) -- Identifiers and Documents (Creation, Upload, Download and View) +- Search of Clients, Client Details Viewing. +- Creating new Clients, Groups, and Centers. +- Savings Accounts and Loan Accounts Viewing. +- Savings Account Transactions (Withdrawal & Deposit). +- Loan Accounts (Approval, Disbursal, Repayments etc). +- Identifiers and Documents (Creation, Upload, Download and View). - Collection Sheet Access (Online), Datatables (View, Add/Remove Entries). - Offline Sync (for Clients, Centers, and Groups) and Offline Dashboard. -- Cheker Inbox -- Path Tracker +- Checker Inbox. +- Path Tracker. -## Screenshots +### Status + +release +Chat +build +commit-activity +license -

- - -

## How to Contribute This is an OpenSource project and we like to see new contributors contibuting to the project. 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. +1. Fork the Project +2. Create Feature Branch + + ```sh + git checkout -b fix_#issue_no + ``` +3. Commit your Changes + + ```sh + git commit -m "feat/design:Add some message" + ``` + +4. Push to the Branch + + ```sh + git push --set-upstream origin fix_#issue_no + ``` + +5. Open a Pull Request + +### Guidelines +- [Issue Tracker](https://github.com/openMF/android-client/blob/master/.github/ISSUE_TEMPLATE.md) +- [Commit Style](https://github.com/openMF/android-client/wiki/Commit-Style-Guide) +- [Pull Request](https://github.com/openMF/android-client/blob/master/.github/PULL_REQUEST_TEMPLATE.md) ## 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). +To start, ensure that you've successfully downloaded and properly configured the Android Studio SDK. You can refer to a guide detailing the setup process [here](http://developer.android.com/sdk/installing/index.html?pkg=studio). ## Building the Code -1. Clone the repository using HTTP: git clone https://github.com/openMF/android-client.git +1. Clone the repository + ```sh + git clone https://github.com/openMF/android-client.git + ``` 2. Open Android Studio. 3. Click on 'Open an existing Android Studio project' @@ -73,15 +97,19 @@ For Windows, you can use the following commands: * `gradlew pmd` an check and apply formatting to any plain-text file.
* `gradlew findbugs` a program which uses static analysis to look for bugs in Java code.
* `gradlew build` provides a command line to execute build script.
-## Wiki -https://github.com/openMF/android-client/wiki +## Contributors + +Special thanks to the incredible code contributors who continue to drive this project forward. -## Product Roadmap + + + + +## Wiki -https://mifosforge.jira.com/wiki/display/MIFOSX/Usability+and+Design - Product Mockup +View [Wiki](https://github.com/openMF/android-client/wiki) ## License -This project is licensed under the open source MPL V2. See -https://github.com/openMF/android-client/blob/master/LICENSE.md +This project is licensed under the open source [MPL V2](https://github.com/openMF/android-client/blob/master/LICENSE.md).