This project aims to provide technological support for GTP group (Groupe de Travail Pluridisciplinaire) lead by the National Civil Aviation and Meteorology Authority (ANACIM). This group aims to contribute to early warning for food security by providing comprehensive information on the agricultural season.
GTP meets every 10d to share past data about water resources situation, market & agriculature, livestock and other. This application provides means to enter or upload data set securely and visualize it under public facing platform.
The project is a DG Toolkit fork, with a custom ui20 module. Check DG Toolkit for its general infrastructure reused in GTP.
Each module can be started independently of the rest. All modules are based on Spring Boot templates. Modules currently present:
-
persistence - this is a module responsible with JPA 2.0 data persistence. It is also provides HATEOAS services on top of the existing entities.
-
web - this module provides REST endpoints for the services needed, as well as basic security. It depends on the persistence module.
-
forms - this module provides admin pages where system, users, data forms and others are configure. It is built with help of the DG Toolkit toolbox of forms, pages, components and other over the entities defined in the persistence module. It uses Apache Wicket as the backend.
-
ui20 - this module provides public facing pages with visualizations. It was created from ReactApp and uses React 16, with Redux store, React-Intl, Semantic UI, Nivo and other packages. It works in conjunction with the web module as the back-end. The Maven build integration is assured by frontend-maven-plugin which invokes npm and webpack. The UI module can be used by both UI developers, with no need of knowledge or Java/Maven local setup and by the back-end developers, with no need to have node.
As prerequisites, we need Java 8 and Maven 3.3.x. In order to build the project, invoke:
mvn install
inside the root project folder.
See Installation Guide for more details.
You can import GTP as a Maven project inside your favorite IDE, it should work in IDEA/STS/Eclipse but you will need Maven 3.3.x.
Follow Gitflow workflow to implement application changes.
Since all the modules are Spring Boot, debugging in STS is really easy. In Spring Boot 1.3 and later there is something called spring-boot-devtools. This dependency is already included in the pom.xml of the modules, uncomment it if you plan to use it. If you do, then in STS you can do Debug As->Spring DevTools Client.
If you have JRebel license, then don't use spring-boot-devtools. Best is to start the modules by invokingn Debug As->Spring Boot App
Fat jars are the way to go when it comes to java micro-services these days. While the pre-built maven project can be easily debugged as described above, a already packaged jar requires remote debugging. You can start the fat jar with remote debugging parameters by invoking:
java -Xverify:none -noverify -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005 -jar fat.jar
... And then for example in STS you can add a new Debug Configuration->Remote Java Application and specify localhost and port 5005.
GTP is DG-toolkit based, that is a package of several modules, among which forms and web are runnable. See the forms and/or the web modules documentation for starting the project.
UI20 module can also run independently with npm start command under ui20 root.
We use the recommended layout and configuration as described in the official documentation by spring boot
To create the image:
mvn install
cd forms
mvn docker:build
This will build the image and automatically add to your local docker daemon.
After this, by running docker images you should be able to see the new image added.
$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
devgateway/toolkit/forms latest 86129946e668 About a minute ago 435.9 MB
frolvlad/alpine-oraclejdk8 slim 00d8610f052e 2 weeks ago 166.6 MB
The image can be started with
$docker run -p 8090:8090 -t devgateway/toolkit/forms
That's it, congrats!