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 1.1 plus Health Check and Metrics
• 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 http://helidon.io/docs/latest.

Get Started

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

Bugs and Feedback

Issues are currently tracked in GitHub, see https://github.com/oracle/helidon/issues

Communication

• Slack: Coming soon
• Twitter: @helidon_project

Downloads / Accessing Binaries

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

Build

You can build Helidon using JDK 8 or 9. 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 http://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

Contributing

We are just getting started, so bear with us while we get the project up and running. We'll have more details about contributing shortly.

We do know that for a pull request to be merged we need the contributor to sign the Oracle Contributor Agreement first. See http://www.oracle.com/technetwork/community/oca-486395.html for details.