liquido-backend-quarkus

This is the java backend for http://www.liquido.vote developed with Quarkus.

LIQUIDO is a free, secure and open eVoting application.

Run LIQUIDO locally for development

Before you can run the LIQUIDO backend service you must make sure, that some preconditions are fulfilled.

LIQUIDO configuration

Check all settings in config/application.properties add your own config/application-local.properties.

PostgreSQL database

The LIQUIDO backend needs an SQL database. You can either spin up one and configure that as a datasource. Or for testing you can use the in-memory H2 database that Quarkus automatically starts for you in dev mode.

-Dquarkus.profile=dev

Create a self-signed TLS certificate for HTTPS

The LIQUIDO backend API is only reachable via HTTPS. You must use a TLS certificate. You can use a self-signed certificate for local development:

openssl req -x509 -newkey rsa:4096 -days 365 -keyout src/main/resources/liquido-TLS-key.pem -out src/main/resources/liquido-TLS-cert.pem
(in Windows git-bash prefix with "winpty" !)

Then configure password for this PEM in application.properties

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./mvnw compile quarkus:dev

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:

./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:

./mvnw package -Dquarkus.package.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 with this command. For this you must have GraalVM installed.

./mvnw package -Pnative

You can then execute your native executable with: ./target/liquido-backend-quarkus-0.1.0-BETA-runner Keep in mind that this is "native" to the platform you are running on, e.g. Windows or Mac. But most container virtualization platforms expect a Linux executable.

Creating a native Linux executable for running inside a Docker container

1. Build a native linux/amd64 executable inside a "builder" container. (This way you don't even have to install GraalVM locally.)
2. Build a Docker IMAGE in amd64 format with the native application executable inside.
3. Run a Docker CONTAINER with that image. Environment variables can be set. And the liquido app inside the container can access the DB outside, ie. on the host.

You can then execute your native executable with: ./target/liquido-backend-quarkus-*-runner

./mvnw package -Pnative -Dquarkus.native.container-build=true

docker build -f src/main/docker/Dockerfile.native-micro --platform linux/amd64 -t doogiemuc/liquido .

docker run --name=liquido-container-1 --env=QUARKUS_DATASOURCE_JDBC_URL=jdbc:postgresql://host.docker.internal:5432/LIQUIDO-DEV --workdir=/work -p 8443:8443 --restart=no --runtime=runc --user=1001 -d liquido/liquido-backend4:latest

If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.

Deploy to fly.io

Fly.io is a cloud service that offers to run images on dedicated edge nodes. This is configured in fly.toml. To deploy the image build above run:

fly deploy --local-only

Further Related Quarkus Guides

• JDBC Driver - H2 (guide): Connect to the H2 database via JDBC
• YAML Configuration (guide): Use YAML to configure your Quarkus application
• Hibernate ORM with Panache (guide): Simplify your persistence code for Hibernate ORM via the active record or the repository pattern
• SmallRye GraphQL (guide): Create GraphQL Endpoints using the code-first approach from MicroProfile GraphQL

Provided Code

YAML Config

Configure your application with YAML

Related guide section...

The Quarkus application configuration is located in src/main/resources/application.yml.

Hibernate ORM

Create your first JPA entity

Related guide section...

Related Hibernate with Panache section...

SmallRye GraphQL

Start coding with this Hello GraphQL Query

Related guide section...