README.md

TODO Application with Quarkus

This is an example application based on a Todo list where the different tasks are created, read, updated, or deleted from the database. This application uses postgresql as a database and that is provided with Quarkus Dev Services. When running in a non-dev mode you will have to provide the database yourself.

Development mode

mvn compile quarkus:dev

Then, open: http://localhost:8080/

Compile and run on a JVM with PostgresSQL ( in a container )

mvn package

Run:

docker run --ulimit memlock=-1:-1 -it --rm=true \
    --name postgres-quarkus-rest-http-crud \
    -e POSTGRES_USER=restcrud \
    -e POSTGRES_PASSWORD=restcrud \
    -e POSTGRES_DB=rest-crud \
    -p 5432:5432 postgres:14
java -jar target/quarkus-app/quarkus-run.jar

Then, open: http://localhost:8080/

Compile to Native and run with PostgresSQL ( in a container )

Compile:

mvn clean package -Pnative

Run:

docker run --ulimit memlock=-1:-1 -it --rm=true \
    --name postgres-quarkus-rest-http-crud \
    -e POSTGRES_USER=restcrud \
    -e POSTGRES_PASSWORD=restcrud \
    -e POSTGRES_DB=rest-crud \
    -p 5432:5432 postgres:14
./target/todo-backend-1.0-SNAPSHOT-runner

Other links

• http://localhost:8080/q/health (Show the build in Health check for the datasource)
• http://localhost:8080/q/openapi (The OpenAPI Schema document in yaml format)
• http://localhost:8080/q/swagger-ui (The Swagger UI to test out the REST Endpoints)
• http://localhost:8080/graphql/schema.graphql (The GraphQL Schema document)
• http://localhost:8080/q/graphql-ui/ (The GraphiQL UI to test out the GraphQL Endpoint)
• http://localhost:8080/q/dev-ui/ (Show dev ui)