https://github.com/eclipse-ee4j/starter
Eclipse Starter for Jakarta EE
https://github.com/eclipse-ee4j/starter
Last synced: 11 months ago
JSON representation
Eclipse Starter for Jakarta EE
- Host: GitHub
- URL: https://github.com/eclipse-ee4j/starter
- Owner: eclipse-ee4j
- License: epl-2.0
- Created: 2020-02-07T16:12:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-25T15:25:10.000Z (about 1 year ago)
- Last Synced: 2025-07-26T11:44:16.865Z (11 months ago)
- Language: HTML
- Homepage:
- Size: 1.11 MB
- Stars: 53
- Watchers: 18
- Forks: 46
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/eclipse-ee4j/starter/releases/tag/ui-2.0.3)
[](https://github.com/eclipse-ee4j/starter/releases/tag/archetype-2.2.1)
# 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 or a web UI.
## Current Release
Please note that this is a development version of the starter. For the current release, please visit
the [project website](https://start.jakarta.ee) 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](https://github.com/eclipse-ee4j/starter/archive/refs/heads/master.zip)). Then
execute the following. Please ensure you have installed a
[Java SE 11+ implementation](https://adoptium.net/?variant=openjdk11)
and [Maven 3+](https://maven.apache.org/download.cgi) (we have tested with Java SE 11, Java SE 17, and
Java SE 21).
```
mvn clean install
```
## Generate Jakarta EE Project Using Archetypes
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](https://adoptium.net/?variant=openjdk8) and
[Maven 3+](https://maven.apache.org/download.cgi) (we have tested with Java SE 8, Java SE 11, Java SE 17,
and Java SE 21).
```
mvn archetype:generate -DarchetypeGroupId="org.eclipse.starter" -DarchetypeArtifactId="jakarta-starter"
```
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](https://www.eclipse.org/ide). 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](https://www.eclipse.org/ide).
To run a specific version of the Archetype, including the locally installed development version, specify
the `archetypeVersion` property.
```
mvn archetype:generate -DarchetypeGroupId="org.eclipse.starter" -DarchetypeArtifactId="jakarta-starter" -DarchetypeVersion="2.7.0-SNAPSHOT"
```
## Running the UI
In order to run the UI, please execute the following from this directory. You can also simply build the war
from Maven and deploy the war to either WildFly 28 or JBoss EAP 8. You can do this in an IDE if desired.
Note that you can override the underlying archetype version used by setting the `ARCHETYPE_VERSION` environment
variable (the default version will be the most recent released to Maven Central, see
[here](https://mvnrepository.com/artifact/org.eclipse.starter/jakarta-starter) for the latest value).
```
mvn clean package wildfly:dev --file ui/pom.xml
```
Once WildFly starts, please go to
[http://localhost:8080/jakarta-starter-ui/](http://localhost:8080/jakarta-starter-ui/). Unzip the file
the UI generates and follow the README.md in the unzipped directory.
## Contributing
We welcome contributions to the project in many forms. Please see the
[Contributing](CONTRIBUTING.md) page for more information.