https://github.com/frostybee/javafx-template
A project template for creating Gradle-enabled JavaFX applications.
https://github.com/frostybee/javafx-template
javafx javafx-gradle javafx-template
Last synced: 9 months ago
JSON representation
A project template for creating Gradle-enabled JavaFX applications.
- Host: GitHub
- URL: https://github.com/frostybee/javafx-template
- Owner: frostybee
- License: mit
- Created: 2023-09-15T03:43:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-22T04:08:16.000Z (11 months ago)
- Last Synced: 2025-03-22T15:51:42.025Z (9 months ago)
- Topics: javafx, javafx-gradle, javafx-template
- Language: Java
- Homepage:
- Size: 41 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JavaFX Project Template
This is a non-modular, Gradle-based project skeleton for creating JavaFX applications.
It uses `JavaFX 20.0.2`, and includes the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) (no need to install Gradle locally).
## Features
- JavaFX-aware coding assistance (code completion, search, navigation in JavaFX-specific source files)
- Logging with [Logback](https://logback.qos.ch/).
- Support for FXML.
- Access to JavaFX's JavaDoc from within your IDE.
- Font icons provided by [Ikonli](https://kordamp.org/ikonli/)
## How Do I Use this Project Template
1. Download this repository as `.zip` file.
2. Unzip the downloaded `javafx-template-main.zip` file.
3. Add the extracted files to your GitHub repo (if you already have one)
4. Open the project with NetBeans
5. Using NetBeans, build the project to download/resolve the dependencies
6. Change the project name in `settings.gradle`
7. Rename the default Java package `edu.vanier.template` to `edu.vanier.projectname` in `MainApp.java` and `MainAppFXMLController.java`.
## How Do I Run Multiple Main Methods?
To execute the main method of a class other than MainApp, you should do so within the `edu.vanier.Launcher` class. For further details, please refer to the examples and comments provided in that class.
**Note:** The `mainClass` property in the `build.gradle` is configured to run the main method of the Launcher class (as shown below):
```gradle
application {
mainClass = 'edu.vanier.Launcher'
}
```
## IDEs and JDK
This project template was tested with `Apache NetBeans 2`, IntelliJ Community Edition 2024.2.02, and `JDK 22`.