realworld-springboot-kotlin

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #typescript #llm #machine-learning #rust #macos #java #vue #pytorch #security #open-source

realworld-springboot-kotlin

(★ 25)

Spring boot kotlin implementation of realworld example.app

realworld-springboot-kotlin Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ![RealWorld Example App](https://raw.githubusercontent.com/raeperd/realworld-springboot-kotlin/master/logo.png)

[![.github/workflows/build-and-deploy.yml](https://github.com/raeperd/realworld-springboot-kotlin/actions/workflows/build-and-deploy.yml/badge.svg)](https://github.com/raeperd/realworld-springboot-kotlin/actions/workflows/build-and-deploy.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=raeperd_realworld-springboot-kotlin&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=raeperd_realworld-springboot-kotlin)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=raeperd_realworld-springboot-kotlin&metric=coverage)](https://sonarcloud.io/summary/new_code?id=raeperd_realworld-springboot-kotlin)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=raeperd_realworld-springboot-kotlin&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=raeperd_realworld-springboot-kotlin)

Spring boot kotlin codebase containing real world examples (CRUD, auth, DDD) that adheres to
the [RealWorld](https://github.com/gothinkster/realworld) spec and API.

### [Demo](https://demo.realworld.io/) &nbsp;&nbsp;&nbsp;&nbsp;[RealWorld](https://github.com/gothinkster/realworld)

This codebase was created to demonstrate a fully fledged fullstack application built with **Spring boot kotlin**
including CRUD operations, authentication, routing, pagination, and more.

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

# Getting started

## Run from scratch

```shell
$ ./gradlew bootRun
```

## Using docker

```shell
$ docker run --rm -it -p 8080:8080 ghcr.io/raeperd/realworld-springboot-kotlin:master 
```

## Run using MySQL as database

```shell
$ docker compose up 
```

- Configure backend database with flyway

```shell
$ SPRING_PROFILES_ACTIVE=develop ./gradlew bootRun
```

- Change profile to develop

## Running tests

### Using shell script

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

### Using gradle test

```shell
$ ./gradlew test
```

# How it works

- Spring Boot for Web API implementations
- Spring Data JPA for persistent layer
- H2 and MySQL for actual database
- Spring's `HandlerInterceptor` for security

## Package Structure

```text
./src/main/kotlin/io/github/raeperd/realworldspringbootkotlin/
├── domain
│   └── article
├── infrastructure
│   ├── jpa
│   └── security
│       └── jwt
└── web
    └── jwt
```

- domain contains only domain logic without explicit dependencies
- infrastructure contains implementation details with external dependencies
- web contains API endpoints and spring web configurations

## Design Principal

- Maintain 90% of code coverages
- Domain logics without external dependencies
- Allow-list for endpoints rather than block-list for authentication
- Reasonable database performance
    - Avoiding N + 1 query problems
    - Explicitly save entity

## Performance

![](https://raw.githubusercontent.com/raeperd/realworld-springboot-kotlin/master/api/performance.png)

- Result of [./api/run-api-tests.sh](./api/run-api-tests.sh) in M1 Mac with 16GM of ram

# See Also

- Java version implementation of this project from my
  repository [raeperd/realworld-springboot-java](https://github.com/raeperd/realworld-springboot-java)
- Another kotlin spring boot implementation
  project [gothinkster/kotlin-spring-realworld-example-app](https://github.com/gothinkster/kotlin-spring-realworld-example-app)

realworld-springboot-kotlin

realworld-springboot-kotlin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

realworld-springboot-kotlin

realworld-springboot-kotlin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README