diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 19 insertions, 19 deletions
@@ -1,46 +1,46 @@ -# pantry Project +# Pantry Project -This project uses Quarkus, the Supersonic Subatomic Java Framework. +This project uses Quarkus, the Supersonic Subatomic Java Framework, and NextJS in a monorepo. 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: +Developing both front-end and back-end in tandem still needs some connecting at the moment. Whenever you make an API change, be sure to grab the OpenAPI spec while the server is running (`http://localhost:8080/q/openapi`) and replace the `src/conf/openapi-pantry.yaml` file. This can be done in one command: + ```shell script -./mvnw compile quarkus:dev +yarn api-update ``` -> **_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: +You can run your application in dev mode that enables live coding using: ```shell script -./mvnw package +yarn dev ``` -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: +This will run both the front-end and back-end watchers to update the running code when it is saved. This can be separately in two commands if preferred: ```shell script -./mvnw package -Dquarkus.package.type=uber-jar +yarn dev:fe +mvn quarkus:dev ``` -The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`. +> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/. ## Creating a native executable +First, generate the front-end code and inject it into the Quarkus server using: + +```shell script +yarn inject +``` + You can create a native executable using: ```shell script -./mvnw package -Pnative +mvn package -Pnative ``` Or, if you don't have GraalVM installed, you can run the native executable build in a container using: ```shell script -./mvnw package -Pnative -Dquarkus.native.container-build=true +mvn package -Pnative -Dquarkus.native.container-build=true ``` You can then execute your native executable with: `./target/pantry-1.0.0-SNAPSHOT-runner` |