Skip to content

Latest commit

 

History

History
87 lines (51 loc) · 2.35 KB

README.md

File metadata and controls

87 lines (51 loc) · 2.35 KB
Raw

Java Code Assignment

This project is designed for a short code assignment that explores various aspects of software development, including API implementation, documentation, persistence layer handling, and testing.

About the assignment

You will find the tasks of this assignment on CODE_ASSIGNMENT file

About the code base

This is based on https://github.com/quarkusio/quarkus-quickstarts

Requirements

To compile and run this demo you will need:

  • JDK 17+

In addition, you will need either a PostgreSQL database, or Docker to run one.

Configuring JDK 17+

Make sure that JAVA_HOME environment variables has been set, and that a JDK 17+ java command is on the path.

Building the demo

Execute the Maven build on the root of the project:

./mvnw package

Running the demo

Live coding with Quarkus

The Maven Quarkus plugin provides a development mode that supports live coding. To try this out:

./mvnw quarkus:dev

In this mode you can make changes to the code and have the changes immediately applied, by just refreshing your browser.

Hot reload works even when modifying your JPA entities.
Try it! Even the database schema will be updated on the fly.

(Optional) Run Quarkus in JVM mode

When you're done iterating in developer mode, you can run the application as a conventional jar file.

First compile it:

./mvnw package

Next we need to make sure you have a PostgreSQL instance running (Quarkus automatically starts one for dev and test mode). To set up a PostgreSQL database with Docker:

docker run -it --rm=true --name quarkus_test -e POSTGRES_USER=quarkus_test -e POSTGRES_PASSWORD=quarkus_test -e POSTGRES_DB=quarkus_test -p 15432:5432 postgres:13.3

Connection properties for the Agroal datasource are defined in the standard Quarkus configuration file, src/main/resources/application.properties.

Then run it:

java -jar ./target/quarkus-app/quarkus-run.jar
Have a look at how fast it boots.
Or measure total native memory consumption...

See the demo in your browser

Navigate to:

http://localhost:8080/index.html

Have fun, and join the team of contributors!

Troubleshooting

Using IntelliJ, in case the generated code is not recognized and you have compilation failures, you may need to add target/.../jaxrs folder as "generated sources".