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

Updated readme to dev also (#238)

Browse Source
This commit is contained in:
Rohan Sharma 2019-01-24 08:57:19 +05:30 committed by Chirag Gupta
parent dd3fc94463
commit 2698bd59fa
1 changed files with 66 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@ -1,11 +1,72 @@
# Mobile Wallet Framework
<img height='175' src="https://user-images.githubusercontent.com/37406965/51083189-d5dc3a80-173b-11e9-8ca0-28015e0893ac.png" align="left" hspace="1" vspace="1">
[![Join the chat at https://gitter.im/openMF/mobile-wallet](https://badges.gitter.im/openMF/mobile-wallet.svg)](https://gitter.im/openMF/mobile-wallet?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# Mobile Wallet
This repository contains a mobile wallet framework based on top of Fineract and clean architecture and contains a core library module
that can be used as a dependency in any other wallet based project.
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
<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.
Further details about building, architecture and documentation are available in the project wiki
| Master | Development | Chat |
|------------|-----------------|-----------------|
| [![Build Status](https://travis-ci.org/openMF/mobile-wallet.svg?branch=master)](https://travis-ci.org/openMF/mobile-wallet) | [![Build Status](https://travis-ci.org/openMF/mobile-wallet.svg?branch=dev)](https://travis-ci.org/openMF/mobile-wallet) | [![Join the chat at https://gitter.im/openMF/mobile-wallet](https://badges.gitter.im/openMF/mobile-wallet.svg)](https://gitter.im/openMF/mobile-wallet?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
## 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>
## 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/mobile-wallet/blob/master/CONTRIBUTING.md">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/CONTRIBUTING.md">here</a>. For commit style guidelines please click <a href="https://github.com/openMF/mobile-wallet/wiki/Commit-style-guide">here</a>.
### 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.
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/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.
* **redesign**
The app is presently being redesigned. All the work done under the redesign domain should be committed to 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/mobile-wallet.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. You will see an error in gradle build related to missing RblClientIdProp and RblClientSecretProp. Add RblClientIdProp and RblClientSecretProp as environment variables with any value.
7. Sync the project again in Android studio.
## Wiki