Apache Fineract: A Platform for Microfinance

Fineract is a mature platform with open APIs that provides a reliable, robust, and affordable core banking solution for financial institutions offering services to the world’s 2 billion underbanked and unbanked.

Requirements

Java >= 1.8 (Oracle JVMs have been tested)
MySQL 5.5

Instructions to run Apache RAT (Release Audit Tool)

Extract the archive file to your local directory.
Download gradle-wrapper.jar version 2.10 and place it in the fineract-provider/gradle/wrapper folder. See 'Instructions to download gradle wrapper' above.
Run ./gradlew rat. A report will be generated under build/reports/rat/rat-report.txt

Instructions to build a war file

Extract the archive file to your local directory.
Ensure gradle-wrapper.jar version 2.10 is present in the fineract-provider/gradle/wrapper folder. See 'Instructions to download gradle wrapper' above.
Run ./gradlew clean war or ./gradlew build to build deployable war file which will be created at build/libs directory.

Instructions to execute Integration tests

Note that if this is the first time to access MySQL DB, then you may need to reset your password.

Create the mifosplatform-tenants database using CREATE DATABASE mifosplatform-tenants.
Create the default tenant database using CREATE DATABASE mifostenant-default.
Download gradle-wrapper.jar version 2.10 and place it in the fineract-provider/gradle/wrapper folder. See 'Instructions to download gradle wrapper' above.
Run the following commands:
1. ./gradlew migrateTenantListDB -PdbName=mifosplatform-tenants
2. ./gradlew migrateTenantDB -PdbName=mifostenant-default
Run ./gradlew clean integrationTest
Run ./gradlew tomcatRunWar

Version

The latest stable release can be viewed on the develop branch: Latest Release on Develop.

The progress of this project can be viewed here: View change log

License

This project is licensed under Apache License Version 2.0. See https://github.com/apache/incubator-fineract/blob/develop/LICENSE.md for referece.

The Connector/J JDBC Driver client library from MariaDB.org, which is licensed under the LGPL, is used in development when running integration tests that use the Flyway library. That JDBC driver is however not included in and distributed with the Fineract product, and is not required to use the product. If you are developer and object to using the LGPL licensed Connector/J JDBC driver, simply do not run the integration tests that use the Flyway library. As discussed in LEGAL-462, this project therefore complies with the Apache Software Foundation third-party license policy.

Apache Fineract Platform API

The API for the Fineract-platform (project named 'Apache Fineract') is documented in the API-docs under Full API Matrix and can be viewed here.

Online Demos

Community App

For this demo, a demo account is also provided for users to experience the functionality of this Community App. Users can use "mifos" for USERNAME and "password" for PASSWORD(without quotation marks).

Developers

Please see https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone for the developers wiki page.

Please refer to https://cwiki.apache.org/confluence/display/FINERACT/Fineract+101 for first time contribution for this project.

Please see https://cwiki.apache.org/confluence/display/FINERACT/How-to+articles for technical details to get started.

Roadmap

Project Release Roadmap on JIRA (Detailed View)

Video Demonstration

Apache Fineract / Mifos X Demo (November 2016) - https://www.youtube.com/watch?v=h61g9TptMBo

Governance and Policies

Becoming a Committer documents the process through which you can become a committer in this project.

Pull Request Size Limit documents that we cannot accept huge "code dump" Pull Requests, with some related suggestions.

More Information

More details of the project can be found at https://cwiki.apache.org/confluence/display/FINERACT.

muarachmann/fineract