Skip to content

soujava/maven-archetype-quickstart

Repository files navigation

Maven archetype - Quickstart Maven Project with Java 21

Introduction

A Maven architype with Java 21 support for facilitate maven project creation.

How to use it from the sources

  1. Make sure that you have already configured the following tools:

    1. Git

    2. Java 21

    3. Maven 3.9+

  2. Clone this repository;

  3. Install the archetype locally:

    mvn clean install
  4. After you do that, you can go to the target directory and perform the following command:

    mvn archetype:generate -DarchetypeCatalog=local
  5. And, the last item on the list will be your locally installed archetype, which you can select by number. Take a look on a sample below:

    [INFO] Scanning for projects...
    [INFO]
    [INFO] ------------------< org.apache.maven:standalone-pom >-------------------
    [INFO] Building Maven Stub Project (No POM) 1
    [INFO] --------------------------------[ pom ]---------------------------------
    [INFO]
    [INFO] >>> archetype:3.2.1:generate (default-cli) > generate-sources @ standalone-pom >>>
    [INFO]
    [INFO] <<< archetype:3.2.1:generate (default-cli) < generate-sources @ standalone-pom <<<
    [INFO]
    [INFO]
    [INFO] --- archetype:3.2.1:generate (default-cli) @ standalone-pom ---
    [INFO] Generating project in Interactive mode
    [INFO] No archetype defined. Using maven-archetype-quickstart (org.apache.maven.archetypes:maven-archetype-quickstart:1.0)
    Choose archetype:
    1: local -> br.org.soujava:maven-archetype-quickstart (Archetype - maven-archetype-quickstart)
    Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): :

How to use it from Maven Repository

mvn archetype:generate -DarchetypeGroupId=br.org.soujava \
    -DarchetypeArtifactId=maven-archetype-quickstart \
    -DgroupId=<GROUP ID> \
    -DartifactId=<ARTIFACT ID> \
    -Dversion=<VERSION> \
    -DprojectDescription=<DESCRIPTION> \
    -Dpackage=<PACKAGE>

Code of Conduct

Take a look at here for more information.

The Code of Conduct of this project is adapted from the Contributor Covenant, version 1.4, available at here.

Contributing

We are very happy you are interested in helping us and there are plenty ways you can do so.

  • Open an Issue: Recommend improvements, changes and report bugs

  • Open a Pull Request: If you feel like you can even make changes to our source code and suggest them, just check out our contributing guide to learn about the development process, how to suggest bugfixes and improvements.

Contact

Join the SouJava Discord server and say hello at #maven-archetype-quickstart channel!