docs(readme): rewrite — Quarkus 3.27.3, branche feature/business-enhancement, STORAGE_PATH override, lionsctl -j 21
This commit is contained in:
77
README.md
77
README.md
@@ -1,58 +1,59 @@
|
||||
# lionsdev-client-impl-quarkus
|
||||
|
||||
This project uses Quarkus, the Supersonic Subatomic Java Framework.
|
||||
> Landing + portail LionsDev — `https://lions.dev`
|
||||
|
||||
If you want to learn more about Quarkus, please visit its website: <https://quarkus.io/>.
|
||||
## Rôle
|
||||
|
||||
## Running the application in dev mode
|
||||
Application web vitrine de l'écosystème LionsDev : présentation des produits (UnionFlow, LUM, BTPXpress), auto-inscription, téléchargements, accès aux différents portails d'administration.
|
||||
|
||||
You can run your application in dev mode that enables live coding using:
|
||||
## Stack
|
||||
|
||||
```shell script
|
||||
| Composant | Technologie |
|
||||
|-----------|-------------|
|
||||
| Framework | Quarkus 3.27.3 LTS |
|
||||
| UI | PrimeFaces 14 + Freya |
|
||||
| Auth | OIDC (Keycloak) |
|
||||
| Java | 21 |
|
||||
|
||||
## Développement local
|
||||
|
||||
```shell
|
||||
./mvnw quarkus:dev
|
||||
```
|
||||
|
||||
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at <http://localhost:8080/q/dev/>.
|
||||
Dev UI : `http://localhost:8080/q/dev/`
|
||||
|
||||
## Packaging and running the application
|
||||
### Storage local
|
||||
|
||||
The application can be packaged using:
|
||||
La propriété `app.storage.base-path` (stockage des fichiers upload) doit être définie. En `%dev`, elle vaut `${user.home}/lionsdev/storage`. En `%prod`, elle lit la variable d'env `STORAGE_PATH`.
|
||||
|
||||
```shell script
|
||||
./mvnw package
|
||||
## Déploiement (lionsctl)
|
||||
|
||||
```bash
|
||||
lionsctl pipeline \
|
||||
-u https://git.lions.dev/lionsdev/lionsdev-client-impl-quarkus \
|
||||
-b feature/business-enhancement \
|
||||
-j 21 -e production -c k1 -p prod
|
||||
```
|
||||
|
||||
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.
|
||||
> ⚠️ La branche prod est `feature/business-enhancement` (pas `main`).
|
||||
|
||||
The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`.
|
||||
**URL prod** : `https://lions.dev`
|
||||
**Health** : `https://lions.dev/q/health`
|
||||
|
||||
If you want to build an _über-jar_, execute the following command:
|
||||
**Pré-requis infrastructure** avant pipeline (migration Helm → lionsctl) :
|
||||
- `Dockerfile` racine (fast-jar, `ubi8/openjdk-21:1.21`, UID 1001, `java -jar` direct)
|
||||
- Deployment Helm existant supprimé au préalable (selector immutable)
|
||||
- Override env `STORAGE_PATH=/tmp/lionsdev-storage` sur le deployment (lionsctl ne l'injecte pas)
|
||||
- Service selector à repatcher après pipeline (retirer labels `app.kubernetes.io/*`)
|
||||
|
||||
```shell script
|
||||
./mvnw package -Dquarkus.package.jar.type=uber-jar
|
||||
## Build
|
||||
|
||||
```shell
|
||||
./mvnw clean package -DskipTests
|
||||
java -jar target/quarkus-app/quarkus-run.jar
|
||||
```
|
||||
|
||||
The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`.
|
||||
## Licence
|
||||
|
||||
## 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/lionsdev-client-impl-quarkus-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
|
||||
|
||||
- PrimeFaces ([guide](https://quarkiverse.github.io/quarkiverse-docs/quarkus-primefaces/dev/)): PrimeFaces - lets you utilize PrimeFaces and PF Extensions to make JavaServer Faces (JSF) development so much easier!
|
||||
Propriétaire — Lions Dev © 2026
|
||||
|
||||
Reference in New Issue
Block a user