https://github.com/bernardo-mg/maven-executable-jar-example
Example of an executable JAR with Maven.
https://github.com/bernardo-mg/maven-executable-jar-example
example executable maven
Last synced: 11 months ago
JSON representation
Example of an executable JAR with Maven.
- Host: GitHub
- URL: https://github.com/bernardo-mg/maven-executable-jar-example
- Owner: Bernardo-MG
- License: mit
- Created: 2020-07-02T10:33:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-28T10:09:41.000Z (almost 3 years ago)
- Last Synced: 2025-01-23T09:10:26.175Z (about 1 year ago)
- Topics: example, executable, maven
- Language: Java
- Homepage:
- Size: 126 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Maven Executable JAR Example
Sets up an executable JAR through Maven. All the configuration is applied in the POM, and the included Main class will be executed.
To test the project first package it:
```
mvn clean package
```
Afterwards a runnable jar will be in the target folder. It can be run like this:
```
java -jar target/executable.jar
```
All it does is printing to the log.
[][site-release]
[][site-develop]
[][javadoc-release]
[][javadoc-develop]
## Features
- Executable JAR using only Maven
## Documentation
Documentation is always generated for the latest release, kept in the 'master' branch:
- The [latest release documentation page][site-release].
- The [latest release Javadoc site][javadoc-release].
Documentation is also generated from the latest snapshot, taken from the 'develop' branch:
- The [the latest snapshot documentation page][site-develop].
- The [latest snapshot Javadoc site][javadoc-develop].
### Building the docs
The documentation site is actually a Maven site, and its sources are included in the project. If required it can be generated by using the following Maven command:
```
$ mvn verify site
```
The verify phase is required, otherwise some of the reports won't be generated.
## Collaborate
Any kind of help with the project will be well received, and there are two main ways to give such help:
- Reporting errors and asking for extensions through the issues management
- or forking the repository and extending the project
### Issues management
Issues are managed at the GitHub [project issues tracker][issues], where any Github user may report bugs or ask for new features.
### Getting the code
If you wish to fork or modify the code, visit the [GitHub project page][scm], where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.
## License
The project has been released under the [MIT License][license].
[issues]: https://github.com/bernardo-mg/maven-executable-jar-example/issues
[javadoc-develop]: http://docs.bernardomg.com/development/maven/maven-executable-jar-example/apidocs
[javadoc-release]: http://docs.bernardomg.com/maven/maven-executable-jar-example/apidocs
[license]: https://www.opensource.org/licenses/mit-license.php
[scm]: https://github.com/bernardo-mg/maven-executable-jar-example
[site-develop]: http://docs.bernardomg.com/development/maven/maven-executable-jar-example
[site-release]: http://docs.bernardomg.com/maven/maven-executable-jar-example