artin/mifos-mobile
1
0
Fork 0
mirror of https://github.com/openMF/mifos-mobile.git synced 2026-02-06 11:26:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs : Update README.md

Browse Source
This commit is contained in:
RajaVamsi11 2019-02-11 15:30:28 +05:30 committed by Rajan Maurya
parent 6dbfa3277a
commit 87fa4671b1
1 changed files with 53 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -1,16 +1,64 @@
<img height='175' src="https://user-images.githubusercontent.com/37406965/51083189-d5dc3a80-173b-11e9-8ca0-28015e0893ac.png" align="left" hspace="1" vspace="1">
# Mifos-Mobile Android Application for MifosX
An Android Application built on top of the MifosX Self-Service platform for end-user customers to view/transact on the accounts and loans they hold. Data visible to customers will be a sub-set of what staff can see. This is a native Android Application written in Java with POJO classes in Kotlin.
### Status
[![Join the chat at https://gitter.im/openMF/self-service-app](https://badges.gitter.im/openMF/self-service-app.svg)](https://gitter.im/openMF/self-service-app?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/openMF/mifos-mobile.svg?branch=development)](https://travis-ci.org/openMF/mifos-mobile)
![App Screenshots](https://user-images.githubusercontent.com/24931732/48102172-b0ccc800-e1de-11e8-9fb9-17c41234636e.png)
# Self Service Android Application for MifosX
## Screenshots
An Android Application built on top of the MifosX Self-Service platform for end-user customers to view/transact on the accounts and loans they hold. Data visible to customers will be a sub-set of what staff can see. This is a native Android Application written in Java with POJO classes in Kotlin.
<p>
<img src="https://user-images.githubusercontent.com/24931732/48102172-b0ccc800-e1de-11e8-9fb9-17c41234636e.png" />
</p>
## Contributing
If you want to start contributing to the project, make sure to read the contributing guidelines [here](https://github.com/openMF/mifos-mobile/blob/development/.github/CONTRIBUTING.md).
## How to Contribute
This is an OpenSource project and we would be happy to see new contributors. The issues should be raised via the GitHub issue tracker.
For Issue tracker guidelines please click <a href="https://github.com/openMF/mifos-mobile/blob/development/.github/ISSUE_TEMPLATE.md">here</a>. All fixes should be proposed via pull requests.
For pull request guidelines please click <a href="https://github.com/openMF/mifos-mobile/blob/development/.github/CONTRIBUTING.md#pull-requests">here</a>. For commit style guidelines please click <a href="https://github.com/openMF/mifos-mobile/wiki/Commit-Style-Guide">here</a>.
### Branch Policy
We have the following branches :
* **development**
All the contributions should be pushed to this branch. If you're making a contribution,
you are supposed to make a pull request to _development_.
Please make sure it passes a build check on Travis.
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 development --single-branch https://github.com/username/mifos-mobile.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.
## 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).
## Building the Code
1. Clone the repository using HTTP: git clone https://github.com/openMF/mifos-mobile.git
2. Open Android Studio.
3. Click on 'Open an existing Android Studio project'
4. Browse to the directory where you cloned the mobile-wallet repo and click OK.
5. Let Android Studio import the project.
6. Build the application in your device by clicking run button.
## Wiki