Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
73 lines
2.3 KiB
Markdown
73 lines
2.3 KiB
Markdown
# core
|
||
|
||
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/>.
|
||
|
||
## Bootstrapping buckets
|
||
|
||
Buckets can be created automatically on startup by setting the environment variable `DEV_DINAUER_R9T_INIT_BUCKETS` to a comma-separated list of bucket names:
|
||
|
||
```shell script
|
||
DEV_DINAUER_R9T_INIT_BUCKETS=invoices,images,backups
|
||
```
|
||
|
||
Alternatively the property `dev.dinauer.r9t.init.buckets` can be set in `application.properties`.
|
||
|
||
- Buckets that already exist are skipped.
|
||
- Bucket names follow the regular naming rules (3-63 characters, lowercase letters, digits, `.` and `-`). An invalid name prevents the application from starting.
|
||
- If the variable is not set, no buckets are created.
|
||
|
||
## 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/core-1.0.0-SNAPSHOT-runner`
|
||
|
||
If you want to learn more about building native executables, please consult <https://quarkus.io/guides/maven-tooling>.
|
||
|
||
## Related Guides
|
||
|
||
- REST ([guide](https://quarkus.io/guides/rest)): Build RESTful web services and APIs using Jakarta REST (formerly JAX-RS)
|