98 lines
4.0 KiB
Markdown
98 lines
4.0 KiB
Markdown
# home4j
|
||
|
||
This project uses Quarkus, the Supersonic Subatomic Java Framework.
|
||
|
||
If you want to learn more about Quarkus, please visit its website: <https://quarkus.io/>.
|
||
|
||
## Running the application in dev mode
|
||
|
||
You can run your application in dev mode that enables live coding using:
|
||
|
||
```shell script
|
||
./mvnw quarkus:dev
|
||
```
|
||
|
||
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at <http://localhost:8080/q/dev/>.
|
||
|
||
## Packaging and running the application
|
||
|
||
The application can be packaged using:
|
||
|
||
```shell script
|
||
./mvnw package
|
||
```
|
||
|
||
It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory.
|
||
Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory.
|
||
|
||
The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`.
|
||
|
||
If you want to build an _über-jar_, execute the following command:
|
||
|
||
```shell script
|
||
./mvnw package -Dquarkus.package.jar.type=uber-jar
|
||
```
|
||
|
||
The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`.
|
||
|
||
## Creating a native executable
|
||
|
||
You can create a native executable using:
|
||
|
||
```shell script
|
||
./mvnw package -Dnative
|
||
```
|
||
|
||
Or, if you don't have GraalVM installed, you can run the native executable build in a container using:
|
||
|
||
```shell script
|
||
./mvnw package -Dnative -Dquarkus.native.container-build=true
|
||
```
|
||
|
||
You can then execute your native executable with: `./target/home4j-0.1.0-SNAPSHOT-runner`
|
||
|
||
If you want to learn more about building native executables, please consult <https://quarkus.io/guides/maven-tooling>.
|
||
|
||
## Related Guides
|
||
|
||
- Qute ([guide](https://quarkus.io/guides/qute)): Offer templating support for web, email, etc in a build time, type-safe way
|
||
- REST Qute ([guide](https://quarkus.io/guides/qute-reference#rest_integration)): Qute integration for Quarkus REST. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it.
|
||
- Hibernate ORM with Panache ([guide](https://quarkus.io/guides/hibernate-orm-panache)): Simplify your persistence code for Hibernate ORM via the active record or the repository pattern
|
||
- REST ([guide](https://quarkus.io/guides/rest)): A Jakarta REST implementation utilizing build time processing and Vert.x. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it.
|
||
- REST Jackson ([guide](https://quarkus.io/guides/rest#json-serialisation)): Jackson serialization support for Quarkus REST. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it
|
||
- SmallRye Health ([guide](https://quarkus.io/guides/smallrye-health)): Monitor service health
|
||
- JDBC Driver - MySQL ([guide](https://quarkus.io/guides/datasource)): Connect to the MySQL database via JDBC
|
||
- Hibernate Validator ([guide](https://quarkus.io/guides/validation)): Validate object properties (field, getter) and method parameters for your beans (REST, CDI, Jakarta Persistence)
|
||
- Security JPA ([guide](https://quarkus.io/guides/security-getting-started)): Secure your applications with username/password stored in a database via Jakarta Persistence
|
||
- SmallRye OpenAPI ([guide](https://quarkus.io/guides/openapi-swaggerui)): Document your REST APIs with OpenAPI - comes with Swagger UI
|
||
- JDBC Driver - H2 ([guide](https://quarkus.io/guides/datasource)): Connect to the H2 database via JDBC
|
||
|
||
## Provided Code
|
||
|
||
### Hibernate ORM
|
||
|
||
Create your first JPA entity
|
||
|
||
[Related guide section...](https://quarkus.io/guides/hibernate-orm)
|
||
|
||
[Related Hibernate with Panache section...](https://quarkus.io/guides/hibernate-orm-panache)
|
||
|
||
|
||
### REST
|
||
|
||
Easily start your REST Web Services
|
||
|
||
[Related guide section...](https://quarkus.io/guides/getting-started-reactive#reactive-jax-rs-resources)
|
||
|
||
### REST Qute
|
||
|
||
Create your web page using Quarkus REST and Qute
|
||
|
||
[Related guide section...](https://quarkus.io/guides/qute#type-safe-templates)
|
||
|
||
### SmallRye Health
|
||
|
||
Monitor your application's health using SmallRye Health
|
||
|
||
[Related guide section...](https://quarkus.io/guides/smallrye-health)
|