Skip to content
Snippets Groups Projects
Commit cb5b2572 authored by Goik Martin's avatar Goik Martin
Browse files

Enhanced documentation

parent 96677a91
No related branches found
No related tags found
No related merge requests found
# Modified Maven archetype # Modified JavaFXML Maven archetype
This archetype has been derived from https://github.com/openjfx/javafx-maven-archetypes / This archetype has been derived from https://github.com/openjfx/javafx-maven-archetypes /
https://mvnrepository.com/artifact/org.openjfx/javafx-archetype-fxml demonstrating JavaFX application assembly. https://mvnrepository.com/artifact/org.openjfx/javafx-archetype-fxml. The following features have been added:
There is added java FXML https://docs.oracle.com/javafx/2/get_started/fxml_tutorial.htm support including both the Log4j
and Junit framework. - FXML support https://docs.oracle.com/javafx/2/get_started/fxml_tutorial.htm
- current Log4j and Junit.
## Hosting ## Hosting
This archetype is being hosted at The archetype is available from
https://maven.mi.hdm-stuttgart.de/nexus/#browse/browse:mi-maven:de%2Fhdm_stuttgart%2Fmi%2Fmi-maven-archetype-javafxml . https://maven.mi.hdm-stuttgart.de/nexus/#browse/browse:mi-maven:de%2Fhdm_stuttgart%2Fmi%2Fmi-maven-archetype-javafxml.
## Getting started ## Getting started
<!-- language-all: bash -->
1. Follow https://freedocs.mi.hdm-stuttgart.de/sd1_sect_mavenCli.html#sd1_fig_mavenMiRepo to configure the above MI 1. Follow https://freedocs.mi.hdm-stuttgart.de/sd1_sect_mavenCli.html#sd1_fig_mavenMiRepo to configure the above MI
Maven Nexus Maven repository server. Maven Nexus Maven repository server for CLI usage.
2. Create a project by executing: 2. Choose your desired archetype version and create a new project by executing:
```bash
mvn archetype:generate -DarchetypeCatalog=local -DarchetypeGroupId=de.hdm-stuttgart.mi \ mvn archetype:generate -DarchetypeCatalog=local -DarchetypeGroupId=de.hdm-stuttgart.mi \
-DarchetypeArtifactId=mi-maven-archetype-javafxml -DarchetypeVersion=21.0.1 \ -DarchetypeArtifactId=mi-maven-archetype-javafxml -DarchetypeVersion=21.0.1 \
-DgroupId=de.mi.hdm_stuttgart -DartifactId=hellojavafx -DinteractiveMode=false -DgroupId=de.mi.hdm_stuttgart -DartifactId=hellojavafx -DinteractiveMode=false
```
3. Execute `mvn javafx:run`. You should see a GUI window popping up. Enter input and see corresponding log entries 4. Execute `mvn javafx:run`. You should see a GUI window popping up. Enter input and see corresponding log entries
in your underlying shell- in your underlying shell. In case you favour the Idea GUI over terminal commands you may click
`Run -->Edit Configurations`. Then add a Maven run configuration entering `javafx:run` in the Run / Command line
textfield mimicking the previous `mvn javafx:run` terminal command.
4. Optional: Working with IntelliJ IDEA follow 4. Optional: Working with IntelliJ IDEA follow
https://freedocs.mi.hdm-stuttgart.de/sd1_sect_idea.html#sd1_fig_mavenIdeaArchetypeCatalogPlugin to configure https://freedocs.mi.hdm-stuttgart.de/sd1_sect_idea.html#sd1_fig_mavenIdeaArchetypeCatalogPlugin to configure
the MI Maven Nexus Maven repository server in your IDE as well. You may add a `javafx:run` to your project's the MI Maven Nexus Maven repository server in your IDE as well. This allows for using the current archetype for
run configurations. creating new JavaFXML projects by virtue of Idea's GUI.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment