/starter

Eclipse Starter for Jakarta EE

Primary LanguageJavaEclipse Public License 2.0EPL-2.0

Eclipse Starter for Jakarta EE

This is the official Eclipse Foundation Starter for Jakarta EE. It generates code to help get started with Jakarta EE projects using Maven. It is possible to do so using Maven Archetypes.

Current Release

Please note that this is a development version of the starter. For the current release, please visit the project website or use Maven Central. This code will allow you to use features that are not yet released. It will also allow you to build the starter from source.

Building from Source

In order to build the project from source, please download this repository on your file system (the easiest way may be to download as zip). Then execute the following. Please ensure you have installed a Java SE 8+ implementation and Maven 3+ (we have tested with Java SE 8, Java SE 11 and Java SE 17).

mvn clean install

Generate Jakarta EE Project

In order to run the Maven Archetype and generate a sample Jakarta EE project, please execute the following. Please ensure you have installed a Java SE 8+ implementation and Maven 3+ (we have tested with Java SE 8, Java SE 11 and Java SE 17).

mvn archetype:generate -DarchetypeGroupId="org.eclipse.starter" -DarchetypeArtifactId="jakarta-starter" -DarchetypeVersion="2.0-SNAPSHOT"

If you use the defaults, this will generate the Jakarta EE project under a directory named jakartaee-hello-world. The README.md file under that directory will contain instructions on how to run the sample.

If desired, you can easily use the Maven Archetype from a Maven capable IDE such as Eclipse. The generated starter code is simply Maven projects. You can easily load, explore and run the code in a Maven capable IDE such as Eclipse.

Known Issues

  • Note that Payara does not yet work on the Apple M1 chip. If you are on an M1 chip, we suggest you use another runtime for the time being with the Archetype.

Contributing

We welcome contributions to the project in many forms. Please see the Contributing page for more information.