realworld-api-quarkus - GitLite

KO | EN

gitlite — search

#python #react #typescript #llm #golang #rust #deep-learning #linux #docker #nodejs #java #cli #pytorch #openai

realworld-api-quarkus

(★ 182)

Simple case of a real world api using quarkus framework.

File Explorer

Download Latest Version (.zip)

- - maven.yml
- - maven-wrapper.properties
- Conduit.postman_collection.json
- run-api-tests.sh
.dockerignore
.gitignore
integrated-tests.sh
LICENSE
mvnw
mvnw.cmd
pom.xml
quarkus-logo.png
README.md

# Installation Guide

1. Get the code

git clone https://github.com/diegocamara/realworld-api-quarkus

Downloads the entire project code from GitHub to your computer.

cd realworld-api-quarkus

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

docker build -f src/main/docker/Dockerfile.jvm -t realworld-api-quarkus .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 realworld-api-quarkus

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Maven (Java)

Medium

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java projects.
Maven The build tool used for the mvn command.

mvn clean install

Installs dependencies and builds the project using Maven.

✅ A BUILD SUCCESS message means it worked. The output is created under target/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ![RealWorld Example App](https://raw.githubusercontent.com/diegocamara/realworld-api-quarkus/master/quarkus-logo.png)

> ### Quarkus Framework codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API.

This codebase was created to demonstrate a fully fledged fullstack application built with [Quarkus](https://quarkus.io/)
including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Quarkus community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to
the [RealWorld](https://github.com/gothinkster/realworld) repo.

[![Java CI with Maven](https://github.com/diegocamara/realworld-api-quarkus/actions/workflows/maven.yml/badge.svg)](https://github.com/diegocamara/realworld-api-quarkus/actions/workflows/maven.yml)

# How it works

This application basically uses Quarkus Framework with Java 25 with some other modules known to development community:

* Hibernate
* Jackson for JSON
* H2 in memory database
* JPA Criteria
* Auth0 java-jwt

### Project structure:

```
application/            -> business orchestration layer
+-- web/                -> web layer models and resources
domain/                 -> core business implementation layer
+-- model/              -> core business entity models
+-- feature/            -> all features logic implementation
+-- validator/          -> model validation implementation 
+-- exception/          -> all business exceptions
infrastructure/         -> technical details layer
+-- configuration/      -> dependency injection configuration
+-- repository/         -> adapters for domain repositories
+-- provider/           -> adapters for domain providers
+-- web/                -> web layer infrastructure models and security
```

# Getting started

### Start local server

```shell
 ./mvnw compile quarkus:dev
 ```

The server should be running at http://localhost:8080

### Running the application tests

```shell
./mvnw test 
```

### Running postman collection tests

```shell
./collections/run-api-tests.sh
```

### Building jar file

```shell
./mvnw package
```

### Building native executable

GraalVM is necessary for building native executable, more information about setting up GraalVM can be found
in [Quarkus guides](https://quarkus.io/guides/)
and database engine need to be changed.

```shell
./mvnw package -Pnative
```

#### Database changes can be made to the application.properties file.

```properties
# Database configuration
quarkus.datasource.db-kind=h2
quarkus.datasource.jdbc.url=jdbc:h2:mem:testdb;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE
quarkus.datasource.jdbc.driver=org.h2.Driver
quarkus.datasource.username=sa
quarkus.datasource.password=
```

## Help

Improvements are welcome, feel free to contribute.