tweak .gitpod.yml and add https://gitpod.io badge to README

- add ASL header (required by ASF RAT)
- change port to 8080 (TODO what was 8005 ?)
- add commands to create DBs
- fix .gitpod.yml database creation
- refine ports in .gitpod.yml
- add port 8081 to ignore in .gitpod.yml
- use test instead of (too slow) integrationTest in .gitpod.yml
- fix .gitpod.yml
  by using https://yaml-multiline.info to fix start-up problem
  due to comment inside tasks / command; ACK Tx to @meysholdt
  for pointing out the right trick here.

see https://github.com/apache/fineract/pull/598/
This commit is contained in:
Michael Vorburger.ch
2019-09-04 22:09:41 +02:00
committed by Michael Vorburger ⛑️
parent 6d26db553b
commit c90888f1bb
2 changed files with 61 additions and 8 deletions
+38 -1
View File
@@ -1,5 +1,42 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
# https://www.gitpod.io
# https://www.gitpod.io/docs/41_Config_Gitpod_File/
# https://github.com/gitpod-io/workspace-images/tree/master/mysql
image: gitpod/workspace-mysql image: gitpod/workspace-mysql
ports: ports:
- port: 3306
onOpen: ignore
- port: 8005 - port: 8005
onOpen: ignore
- port: 8009
onOpen: ignore
- port: 8080
- port: 8081
onOpen: ignore
- port: 8443
tasks: tasks:
- command: ./gradlew install - command: |
# NB MySQL on GitPod.io is currently quite slow.
# similar to .travis.yml, but using authentication_string= instead of password= due to mysql major version difference
mysql -e "USE mysql;\nUPDATE user SET authentication_string=PASSWORD('mysql') WHERE user='root';\nFLUSH PRIVILEGES;\n"
./gradlew createDB -PdbName=mifosplatform-tenants
./gradlew createDB -PdbName=mifostenant-default
./gradlew build -x test
+22 -6
View File
@@ -1,9 +1,16 @@
Apache Fineract: A Platform for Microfinance [![Build Status](https://travis-ci.org/apache/fineract.svg?branch=develop)](https://travis-ci.org/apache/fineract) [![Docker Hub](https://img.shields.io/docker/pulls/apache/fineract.svg)](https://hub.docker.com/r/apache/fineract) [![Docker Build](https://img.shields.io/docker/cloud/build/apache/fineract.svg)](https://hub.docker.com/r/apache/fineract/builds) Apache Fineract: A Platform for Microfinance [![Build Status](https://travis-ci.org/apache/fineract.svg?branch=develop)](https://travis-ci.org/apache/fineract) [![Docker Hub](https://img.shields.io/docker/pulls/apache/fineract.svg)](https://hub.docker.com/r/apache/fineract) [![Docker Build](https://img.shields.io/docker/cloud/build/apache/fineract.svg)](https://hub.docker.com/r/apache/fineract/builds)
============ ============
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. 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.
[Have a look at the FAQ on our Wiki at apache.org](https://cwiki.apache.org/confluence/display/FINERACT/FAQ) if this README does not answer what you are looking for. [Have a look at the FAQ on our Wiki at apache.org](https://cwiki.apache.org/confluence/display/FINERACT/FAQ) if this README does not answer what you are looking for.
[![Code Now! (Gitpod)](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/apache/fineract)
to start contributing to this project in the online web-based IDE GitPod.io right away!
(You may initially have to press F1 to Find Command and run "Java: Start Language Server".)
It's of course also possible to contribute with a "traditional" loca ldevelopment environment (see below).
Requirements Requirements
============ ============
* Java >= 1.8 (Oracle JVMs have been tested) * Java >= 1.8 (Oracle JVMs have been tested)
@@ -35,18 +42,20 @@ The file fineract-provider/gradle/wrapper/gradle-wrapper.jar binary is checked i
but won't exist in your copy of the Fineract codebase if you downloaded a released source archive from apache.org. but won't exist in your copy of the Fineract codebase if you downloaded a released source archive from apache.org.
In that case, you need to downloaded it using the commands below: In that case, you need to downloaded it using the commands below:
wget --no-check-certificate -P fineract-provider/gradle/wrapper https://github.com/apache/fineract/raw/develop/fineract-provider/gradle/wrapper/gradle-wrapper.jar wget --no-check-certificate -P fineract-provider/gradle/wrapper https://github.com/apache/fineract/raw/develop/fineract-provider/gradle/wrapper/gradle-wrapper.jar
(or) (or)
curl --insecure -L https://github.com/apache/fineract/raw/develop/fineract-provider/gradle/wrapper/gradle-wrapper.jar > fineract-provider/gradle/wrapper/gradle-wrapper.jar curl --insecure -L https://github.com/apache/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) Instructions to run Apache RAT (Release Audit Tool)
============ ============
1. Extract the archive file to your local directory. 1. Extract the archive file to your local directory.
2. Run `./gradlew rat`. A report will be generated under build/reports/rat/rat-report.txt 2. Run `./gradlew rat`. A report will be generated under build/reports/rat/rat-report.txt
Instructions to build a war file
Instructions to build a WAR file
============ ============
1. Extract the archive file to your local directory. 1. Extract the archive file to your local directory.
2. Run `./gradlew clean war` or `./gradlew build` to build deployable war file which will be created at build/libs directory. 2. Run `./gradlew clean war` or `./gradlew build` to build deployable war file which will be created at build/libs directory.
@@ -84,11 +93,12 @@ https://hub.docker.com/r/apache/fineract has a pre-built container of this proje
You can use a MySQL database from a different or remote server by passing the server's IP address to the docker finerect buid process like this: You can use a MySQL database from a different or remote server by passing the server's IP address to the docker finerect buid process like this:
`docker build --build-arg mysqlserver=<MySQL server IP> -t fineract:latest .` docker build --build-arg mysqlserver=<MySQL server IP> -t fineract:latest .
The run it: The run it:
`docker run -d fineract:latest` docker run -d fineract:latest
Version Version
============ ============
@@ -97,6 +107,7 @@ The latest stable release can be viewed on the develop branch: [Latest Release o
The progress of this project can be viewed here: [View change log](https://github.com/apache/fineract/blob/develop/CHANGELOG.md "Latest release change log") The progress of this project can be viewed here: [View change log](https://github.com/apache/fineract/blob/develop/CHANGELOG.md "Latest release change log")
License License
============ ============
@@ -117,12 +128,14 @@ Apache Fineract Platform API
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"). 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 Online Demos
============ ============
* [Community App](https://demo.openmf.org "Reference Client App") * [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). > 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 Developers
============ ============
Please see <https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone> for the developers wiki page. Please see <https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone> for the developers wiki page.
@@ -137,11 +150,13 @@ Roadmap
[Project Release Roadmap on JIRA (Detailed View)](https://issues.apache.org/jira/browse/FINERACT-268?jql=project%20%3D%20FINERACT "Project Release Roadmap on JIRA (Detailed View)") [Project Release Roadmap on JIRA (Detailed View)](https://issues.apache.org/jira/browse/FINERACT-268?jql=project%20%3D%20FINERACT "Project Release Roadmap on JIRA (Detailed View)")
Video Demonstration Video Demonstration
============ ============
Apache Fineract / Mifos X Demo (November 2016) - <https://www.youtube.com/watch?v=h61g9TptMBo> Apache Fineract / Mifos X Demo (November 2016) - <https://www.youtube.com/watch?v=h61g9TptMBo>
Governance and Policies Governance and Policies
======================= =======================
@@ -151,6 +166,7 @@ documents the process through which you can become a committer in this project.
[Pull Request Size Limit](https://cwiki.apache.org/confluence/display/FINERACT/Pull+Request+Size+Limit) [Pull Request Size Limit](https://cwiki.apache.org/confluence/display/FINERACT/Pull+Request+Size+Limit)
documents that we cannot accept huge "code dump" Pull Requests, with some related suggestions. documents that we cannot accept huge "code dump" Pull Requests, with some related suggestions.
More Information More Information
============ ============
More details of the project can be found at <https://cwiki.apache.org/confluence/display/FINERACT>. More details of the project can be found at <https://cwiki.apache.org/confluence/display/FINERACT>.