diff --git a/DISCLAIMER b/DISCLAIMER new file mode 100644 index 000000000..3854c3636 --- /dev/null +++ b/DISCLAIMER @@ -0,0 +1 @@ +Apache Fineract is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. \ No newline at end of file diff --git a/README.md b/README.md index 11f8b649e..8e9b096f0 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,31 @@ Apache Fineract: A Platform for Microfinance -====== +============ The next evolution of fineract focussing on being faster, lighter and cheaper to change (than existing mifos) so that it is more responsive to the needs of MFI’s and Integrators -Build Status +Requirements +============ +. Java >= 1.8 (Oracle JVMS have been tested) +. gradle-wrapper.jar version 2.10 +. MySQL 5.5 + +Instructions to build war file ============ -Travis +1. Extract the archive file to your local directory +2. Download gradle-wrapper.jar version 2.10 and place it in fineract-provider/gradle/wrapper folder +3. Change current working directory to fineract-provider +4. Run './gradlew clean war' to build deployable war file which will be created at fineract-provider/build/libs directory -[![Build -Status](https://travis-ci.org/openMF/mifosx.png?branch=master)](https://travis-ci.org/openMF/mifosx) - -Cloudbees Jenkins - -[![Build -Status](https://openmf.ci.cloudbees.com/job/MIFOSX%20INTEGRATION%20TEST/badge/icon)](https://openmf.ci.cloudbees.com/job/MIFOSX%20INTEGRATION%20TEST/) - -Jenkins@CloudBees Unit + Integration Tests +Instructions to execute Integration tests +============ +1. Login to mysql DB using 'mysql -u root -pmysql' +2. Create mifosplatform-tenants database using create database `mifosplatform-tenants`; +3. Create default tenant database using create database `mifostenant-default`; +4. With fineract-provider as current working directory run below commands +4.a. ./gradlew migrateTenantListDB -PdbName=mifosplatform-tenants +4.b. ./gradlew migrateTenantDB -PdbName=mifostenant-default +5. Run './gradlew clean integrationTest' -Version -========== - -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 - - -Latest stable release can always been viewed on master branch: Latest Release on Master, View change log - -License -============= - -This project is licensed under the open source MPL V2. See https://github.com/openMF/mifosx/blob/master/LICENSE.md - -Fineract Platform API -===================== - -API Documentation (Demo Server) - - -Online Demos -============================= - -* Community App -* ~~Reference Client App (Deprecated)~~ - -Developers -========== -see https://mifosforge.jira.com/wiki/display/MIFOSX/MifosX+Technical - Developers Wiki Page - -see https://mifosforge.jira.com/wiki/display/MIFOSX/Getting+started+-+Contributing+to+MifosX - Getting Started. - -see https://mifosforge.jira.com/wiki/display/MIFOSX/The+Basic+Design - Overview of Platform Implementation - -see https://github.com/openMF/mifosx/wiki/Screen-Based-Reporting for info around reporting - -see https://github.com/openMF/mifosx/wiki/Git-Usuage for info around using git - -see https://www.ohloh.net/p/mifosx for activity overview and basic code analysis. - -Roadmap -============== - -Community Roadmap (High Level) - -Project Release Roadmap on JIRA (Detailed View) - -Video Demonstration -=============== - -Demonstration of first Prototype of this platform with browser App (April 2012) - http://www.youtube.com/watch?v=zN5Dn1Lc_js +More details of the project can be found at https://cwiki.apache.org/confluence/display/FINERACT \ No newline at end of file