Example realworldapp backend

examples/realworld-app/README.md

@@ -0,0 +1,76 @@
+# ![RealWorld Example App](rw-logo.png)
+
+> ### Spring Boot + Elasticsearch codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API
+
+### [RealWorld](https://github.com/gothinkster/realworld)
+
+This codebase was created to demonstrate a fully fledged fullstack application built with **Java + Spring Boot +
+Elasticsearch** including CRUD operations, authentication, routing, pagination, and more.
+
+We've gone to great lengths to adhere to the **Java + Spring Boot + Elasticsearch** 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.
+
+# How it works
+
+The application was made mainly demonstrate the
+new [Elasticsearch Java API Client](https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/index.html).
+
+The application was built with:
+
+- [Java](https://www.java.com/en/) as programming language
+- [Spring Boot](https://spring.io/projects/spring-boot) as dependency injection framework
+- [Gradle](https://github.com/gradle/gradle) as build tool
+- [Elasticsearch](https://github.com/elastic/elasticsearch) as database
+- [Jackson](https://github.com/FasterXML/jackson-core) as data bind serialization/deserialization
+- [Java JWT](https://github.com/jwtk/jjwt) for JWT implementation
+- [Jaxb](https://github.com/jakartaee/jaxb-api) for JWT parsing
+- [Slugify](https://github.com/slugify/slugify) for slug
+
+Tests:
+
+- [Junit](https://github.com/junit-team/junit4)
+- [Testcontainers](https://github.com/testcontainers) to create an Elasticsearch instance
+
+#### Structure
+
+This is a multimodule gradle project:
+
+- rw-database
+    - Elasticsearch client connection, queries, document classes
+- rw-rest
+    - Spring rest controllers
+- rw-server
+    - Configuration and entrypoint. Main class: [SpringBootApp.java](rw-server/src/main/java/realworld/SpringBootApp.java)
+
+# Getting started
+
+#### JVM
+
+A version of the JVM has to be installed, openjdk version "21.0.2" was used during development.
+
+#### Elasticsearch
+
+An Elasticsearch instance needs to be running for the application to start successfully.
+To start one easily, a [docker-compose](docker-compose.yaml) is provided, it will start Elasticsearch on port 9200 and
+Kibana on [5601](http://localhost:5601/app/home#/); otherwise, the connection properties can be changed in [application.properties](rw-server/src/main/resources/application.properties).
+
+### Build:
+
+> ./gradlew clean build
+
+#### Start the server:
+
+> ./gradlew run
+
+#### Run
+
+The application will start on [8080](http://localhost:8080/api) with `api` context, it can be changed
+in [application.properties](rw-server/src/main/resources/application.properties).
+
+### Unit tests
+
+A basic [unit test](rw-database/src/test/java/realworld/db/UserServiceTest.java) using testcontainer (docker is
+required).

examples/realworld-app/build.gradle

@@ -0,0 +1,25 @@
+plugins {
+  id 'java'
+  id 'org.springframework.boot' version '3.2.1'
+  id 'io.spring.dependency-management' version '1.1.4'
+  id 'application'
+}
+
+group = 'realworldapp'
+version = '0.0.1-SNAPSHOT'
+
+java {
+  sourceCompatibility = '21'
+}
+
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  implementation('org.springframework.boot:spring-boot-starter-parent:3.2.0')
+  implementation('realworldapp:rw-server')
+}
+
+mainClassName = 'rw-server/src/main/java/realworld/SpringBootApp.java'
+

examples/realworld-app/docker-compose.yaml

@@ -0,0 +1,29 @@
+services:
+  es:
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.11.1
+    container_name: es
+    environment:
+      "discovery.type": "single-node"
+      "xpack.security.enabled": "false"
+      "xpack.security.http.ssl.enabled": "false"
+    ports:
+      - "9200:9200"
+    networks:
+      - elastic
+  kibana:
+    image: docker.elastic.co/kibana/kibana:8.7.1
+    container_name: kibana
+    environment:
+      XPACK_ENCRYPTEDSAVEDOBJECTS_ENCRYPTIONKEY: d1a66dfd-c4d3-4a0a-8290-2abcb83ab3aa
+    ports:
+      - 5601:5601
+    networks:
+      - elastic
+    deploy:
+      resources:
+        limits:
+          cpus: '2.0'
+        reservations:
+          cpus: '1.0'
+networks:
+  elastic:

examples/realworld-app/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists