Giter Club home page Giter Club logo

helidon's Introduction

latest version latest version build status follow on Twitter

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 https://helidon.io/docs/latest.

Get Started

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

Bugs and Feedback

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

Communication

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 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 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

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 https://www.oracle.com/technetwork/community/oca-486395.html for details.

helidon's People

Contributors

romain-grecourt avatar barchetta avatar spericas avatar tomas-langer avatar tjquinno avatar delabassee avatar m0mus avatar helidonrobot avatar

Watchers

duansm avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.