Initial contribution about Fineract project (#449)

* Update README to make first-time contributor easy to get started.

* Update the integration test part of README.
1. There is a lack of space of the command to access mysql db.
2. The name of mysql database should not contain "-", so I change "-" to "_" in order to avoid the syntax error.
This commit is contained in:
dingfan
2019-02-04 16:22:22 +01:00
committed by Michael Vorburger ⛑️
parent 97ed2549de
commit 4784223a35
+19 -10
View File
@@ -5,16 +5,18 @@ The next evolution of Apache Fineract focuses on being faster, lighter and cheap
Requirements
============
* Java >= 1.8 (Oracle JVMS have been tested)
* Java >= 1.8 (Oracle JVMs have been tested)
* gradle-wrapper.jar version 2.10
* MySQL 5.5
Instructions to download gradle wrapper
============
By running following command, it will download the gradle wrapper from Fineract git repository and puts under fineract-provider/gradle/wrapper
By running following command, it will download the gradle wrapper from Fineract git repository and put it under fineract-provider/gradle/wrapper
wget --no-check-certificate -P fineract-provider/gradle/wrapper https://github.com/apache/incubator-fineract/raw/develop/fineract-provider/gradle/wrapper/gradle-wrapper.jar
(or)
curl --insecure -L https://github.com/apache/incubator-fineract/raw/develop/fineract-provider/gradle/wrapper/gradle-wrapper.jar > fineract-provider/gradle/wrapper/gradle-wrapper.jar
Instructions to run Apache RAT (Release Audit Tool)
@@ -32,42 +34,49 @@ Instructions to build war file
Instructions to execute Integration tests
============
1. Login to mysql DB using `mysql -u root -pmysql`
2. Create the mifosplatform-tenants database using `CREATE DATABASE mifosplatform-tenants`.
3. Create the default tenant database using `CREATE DATABASE mifostenant-default`.
1. Login to mysql DB using `mysql -u root -p mysql`
> Note that if this is the first time to access MySQL DB, then you may need to reset your password.
2. Create the mifosplatform-tenants database using `CREATE DATABASE mifosplatform_tenants`.
3. Create the default tenant database using `CREATE DATABASE mifostenant_default`.
4. Download gradle-wrapper.jar version 2.10 and place it in the fineract-provider/gradle/wrapper folder. See 'Instructions to download gradle wrapper' above.
5. Run the following commands:
1. `./gradlew migrateTenantListDB -PdbName=mifosplatform-tenants`
2. `./gradlew migrateTenantDB -PdbName=mifostenant-default`
1. `./gradlew migrateTenantListDB -PdbName=mifosplatform_tenants`
2. `./gradlew migrateTenantDB -PdbName=mifostenant_default`
6. Run `./gradlew clean integrationTest`
7. Run `./gradlew tomcatRunWar`
Version
============
The latest stable release can be viewed on the develop branch: [Latest Release on Develop](https://github.com/apache/incubator-fineract/tree/develop "Latest Release"), [View change log](https://github.com/apache/incubator-fineract/blob/develop/CHANGELOG.md "Latest release change log")
The latest stable release can be viewed on the develop branch: [Latest Release on Develop](https://github.com/apache/incubator-fineract/tree/develop "Latest Release").
The progress of this project can be viewd here: [View change log](https://github.com/apache/incubator-fineract/blob/develop/CHANGELOG.md "Latest release change log")
License
============
This project is licensed under Apache License Version 2.0. See <https://github.com/apache/incubator-fineract/blob/develop/LICENSE.md>.
This project is licensed under Apache License Version 2.0. See <https://github.com/apache/incubator-fineract/blob/develop/LICENSE.md> for referece.
Apache Fineract Platform API
============
The API for the Fineract-platform (project named 'Apache Fineract') is documented in the API-docs under <b>Full API Matrix</b> and can be viewed [here](https://demo.openmf.org/api-docs/apiLive.htm "API Documentation").
The API for the Fineract-platform (project named 'Apache Fineract') is documented in the API-docs under <b><i>Full API Matrix</i></b> and can be viewed [here](https://demo.openmf.org/api-docs/apiLive.htm "API Documentation").
Online Demos
============
* [Community App](https://demo.openmf.org "Reference Client 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
============