Development Note

• Project information
• Setup development environment
• Get Started

Setup development environment

Prerequisites

• Java 8

• Gradle: Build Tool

  • The project is compatible with Gradle 4.10.x, then you should install the right version here
  • If your computer already installed Gradle 5.x.x, use gradlew/gradlew.bat instead (in the root directory of project). For example:

  gradlew.bat --version
  

• Docker

• Understand some resources:

  • https://vertx.io/docs/guide-for-java-devs/
  • https://github.com/ReactiveX/RxJava

IDE

Intellij

More details

• Java 8

  • From Project panel, click on root item and press F4
  • Normally, java 1.8 will be available in Project SDK under Project session.
    
  • If it is not available, click on New -> JDK
  • Browser to your JDK8 installation folder
  • Click OK to save your changes
    

• Gradle

  • From Intellij menu, open File -> Settings
  • From left panel search box, input 'gradle'
  • Select Gradle session under Build, Execution, Deployment -> Build Tools
  • From right panel, check on the Use gradle 'wrapper' task configuration then press OK
    

• Importing code style

  • Download and unzip the templates from here
  • From Intellij menu, open File -> Settings, select Editor -> Code Style session
  • From right panel, click to settings icon, select Import Scheme -> Intellij IDEA code style XML
    
  • Browser to your code style downloaded above, select java-intellij-zero-style.xml then Ok.
    
  • The ZeroStyle scheme will be available and selected by default.
  • Click OK to close Setting panel and apply your changes.

• Install Intellij lombok plugin

  • From Intellij menu, open File -> Settings, select Plugins session
  • Open Marketplace tab, from the plugins search box (right panel), input 'lombok' then Enter
  • From the search result, Lombok plugin will be available, click on Install button

• Enable Annotation processing

  • From Intellij menu, open File -> Settings, select Build, Execution, Deployment -> Compiler -> Annotation Processors
  • From the right panel, check on Enable annotation processing then press OK
    

• Enable auto generate src folder

  • File -> Settings -> Build, Execution, Deployment -> Gradle -> check the "Create directories for empty content roots automatically"

Eclipse

More details

TBD

Docker

More details

Linux and Windows

• Install docker in Ubuntu or Windows or Mac

• Install docker compose

  Noted:

  • Post install for Linux https://docs.docker.com/install/linux/linux-postinstall/
  • For Windows, please ensure that you already had Microsoft .NET Framework 4.5 installed.

Running docker remotely

It is useful when your development environment is Windows but docker is running in Linux

• Install virtual machine running Linux (VMWare or Oracle virtual toolbox)
• Install docker in your Linux virtual machine
• Enable remote api in your docker host. Follow this guide
• Verifying remote api is enabled by opening http://$docker_remote_host_ip:$docker_remote_port/containers/json in Web browser from Windows machine.
  Replace $docker_remote_host_ip by your docker host's ip and $docker_remote_port by your setting port in previous step.
  For example http://192.168.100.119:2376/containers/json
  Noted: the response could be empty if there is no running container in your docker
• In your Windows machine, install chocolately
• Running following command to install docker cli

  choco install docker
  

Get Started

Required

• Prerequisites
• Docker is desirable. Refers useful startup scripts
• Create nexus.secret.properties with content:

  nexusSnapshotUrl=http://<your-nexus-server>/repository/maven-snapshots/
  nexusReleaseURL=http://<your-nexus-server>/repository/maven-releases/
  nexusUsername=<your-nexus-user>
  nexusPassword=<your-nexus-password>

• Create docker.secret.properties with content:

  dockerHost=<your-docker-host>

  • linux|macos: unix:///var/run/docker.sock
  • windows: tcp://<your_docker_host>:<your_docker_port>

Build

• Build local: compile and build to jar file, then push artifact to local maven repository.

  gradle clean jooq build uberJar

• Publish artifacts to Nexus server:

  gradle publish

Run Sandbox

• Build docker image: gradle clean jooq build docker
• Refers Sandbox

Interact REST API

Will be part of Swagger UI soon. Try Postman version first.