Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
miguno committed May 7, 2024
1 parent 7f42517 commit 5ddabed
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,8 @@ Java JDK or Maven installed.
# Usage and Demo

**Step 1:** Create the Docker image according to [Dockerfile](Dockerfile).
This step uses Maven to build, test, and package the
[Java application](src/main/java/com/miguno/App.java) according to
[pom.xml](pom.xml). The resulting image is 102MB in size, of which 44MB are
This step uses Maven to build, test, and package the Java application according
to [pom.xml](pom.xml). The resulting image is 102MB in size, of which 44MB are
the underlying `alpine` image.

```shell
Expand Down Expand Up @@ -95,26 +94,31 @@ commands above more conveniently as per this project's [justfile](justfile):
$ just
Available recipes:
audit # audit the code
build # alias for 'compile'
build-native # build the native application locally (requires GraalVM)
clean # clean (remove) the build artifacts
compile # compile the project
coverage # create coverage report
default # print available targets
dev # run the application locally (in Quarkus development mode) with live reload
docker-image-create # create a docker image (requires Docker)
docker-image-run # run the docker image (requires Docker)
docker-image-size # size of the docker image (requires Docker)
evaluate # evaluate and print all just variables
format # format sources
format-check # check formatting of sources (without modifying)
infer # static code analysis via infer (requires https://github.com/facebook/infer)
package # package the application to create an uber jar
pom # print effective pom.xml
run # run the application locally
run-native # run the native application locally (requires GraalVM)
send-request-to-app # send request to the app's HTTP endpoint (requires Docker and running app container)
site # generate site incl. reports for spotbugs, dependencies, licenses
site # generate site incl. reports for spotbugs, dependencies, javadocs, licenses
spotbugs # static code analysis with spotbugs
system-info # print system information such as OS and architecture
test # run unit tests
test-integration # run integration tests (without unit tests)
verify # run all tests, plus static code analysis with spotbugs
upgrade-mvnw # upgrade mvnw a.k.a. maven wrapper
verify # run unit and integration tests, plus coverage check and static code analysis
verify-native # same as 'verify', but for the native application (requires GraalVM)
```

Expand Down

0 comments on commit 5ddabed

Please sign in to comment.