README.md

Helidon: Java Libraries for Microservices

Project Helidon is a set of Java Libraries for writing microservices. Helidon supports two programming models:

• Helidon MP: MicroProfile 3.2
• Helidon SE: a small, functional style API

In either case your application is just a Java SE program.

Documentation

Latest documentation and javadocs are available at https://helidon.io/docs/latest.

Get Started

See Getting Started at https://helidon.io.

Downloads / Accessing Binaries

There are no Helidon downloads. Just use our Maven releases (GroupID io.helidon). See Getting Started at https://helidon.io.

Build

You can build Helidon using JDK 8 or above. Building with 9+ results in jar files that are valid Java 9 modules containing Java 8 bytecodes.

You also need Maven. We recommend 3.5 or newer.

Building the documentation requires the dot utility from Graphviz. This is included in many Linux distributions. For other platforms see https://www.graphviz.org/.

Full build

$ mvn install

Checkstyle

# Cd to the component you want to check
$ mvn validate  -Pcheckstyle

Copyright

# Cd to the component you want to check
$ mvn validate  -Pcopyright

Spotbugs

# Cd to the component you want to check
$ mvn verify  -Pspotbugs

Build Scripts

Build scripts are located in etc/scripts. These are primarily used by our pipeline, but a couple are handy to use on your desktop to verify your changes.

• copyright.sh: Run a full copyright check
• checkstyle.sh: Run a full style check

Get Help

• See the Helidon FAQ
• Ask questions on Stack Overflow using the helidon tag
• Join us on Slack: #helidon-users

Get Involved

• Learn how to contribute
• See issues for issues you can help with

Stay Informed

• Twitter: @helidon_project
• Blog: Helidon on Medium