Macchinetta Batch Framework (2.x) Development Guideline

This guideline provides best practices to develop highly maintainable Batch applications using full stack framework focussing on Spring Framework, Spring Batch and MyBatis.

This guideline helps to proceed with the software development (mainly coding) smoothly.

Note	Stable guidelines GitHub contents is under construction. Stable guidelines refer to here.

How to contribute

Contributing (bug report, pull request, any comments etc.) is welcome !! Please see the contributing guideline for details.

Source files

Source files of this guideline are stored into following directories.

Japanese version : {repository root}/src/main/asciidoc/ja/

Source file format

This guideline is written by the Asciidoctor format(.adoc). About the Asciidoctor format, refer to the Asciidoctor documentation contents.

How to build

We build to Diagram, HTML, and PDF files using the Asciidoctor Maven Plugin.

Diagram build requires Graphviz's dot command tool. (We use Graphviz 2.50.0 to build diagrams. Graphviz before 2.50.0 may have a problem that leads to generate corrupted diagrams.) Please download here and set system path.

Clone a repository

Please clone a Macchinetta/batch-guideline repository or forked your repository.

$ git clone https://github.com/Macchinetta/batch-guideline.git

$ git clone https://github.com/{your account}/batch-guideline.git

Build HTML and PDF files for the Japanese

Please execute the two mvn command. If build is successful, HTML and PDF files generate to the directory below.

HTML : {your repository}/target/generated-docs/html
PDF : {your repository}/target/generated-docs/pdf

$ mvn -f image_pom.xml
$ mvn

Build HTML files for the Japanese

Please execute the two mvn command with profile specification. If build is successful, HTML files generate to the directory below.

HTML : {your repository}/target/generated-docs/html

$ mvn -f image_pom.xml
$ mvn -P ja-html-only

Macchinetta/batch-guideline