https://github.com/4ntoine/notesserverapp

Notes server-side app (clean architecture)
https://github.com/4ntoine/notesserverapp

clean-architecture grpc kotlin kotlin-multiplatform rest-api

Last synced: 2 months ago
JSON representation

Notes server-side app (clean architecture)

• Host: GitHub
• URL: https://github.com/4ntoine/notesserverapp
• Owner: 4ntoine
• Created: 2019-05-30T20:22:10.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-06-20T22:43:21.000Z (almost 4 years ago)
• Last Synced: 2024-07-30T19:23:19.705Z (over 1 year ago)
• Topics: clean-architecture, grpc, kotlin, kotlin-multiplatform, rest-api
• Language: Kotlin
• Size: 2.46 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/4ntoine/NotesServerApp.svg?branch=master)](https://travis-ci.org/4ntoine/NotesServerApp)

# The project

## Server-side

This is a server-side JVM application for simple notes keeping (you can add and list notes via REST and gRPC) implemented in [clean architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html) in Kotlin.

## Client-side

Check out according [client-side app(s)](https://github.com/4ntoine/NotesClientApp).

`domain` and `app-api` are Kotlin Multiplatform modules.

Install them to local Maven repository for the JVM clients:

    ./gradlew publishToMavenLocal

Generate CocoaPod specs for iOS clients (iOS simulator target only - `iosX64`):

    ./gradlew podspec

    

Note: while Kotlin/Multiplatform is still experimental

`-Xuse-experimental=kotlin.ExperimentalMultiplatform` compiler option is used.    

# The motivation

Here is a quick recap of the benefits that clean architecture brings:

* Independent of Frameworks

* Testable

* Independent of UI

* Independent of Database

* Independent of any external agency

You can find few more README.md files in subdirectories.

# Clean architecture implementation

Find the classes in clean architecture diagram:

![Clean architecture diagram](images/arch/my_clean_arch.png?raw=true)

![Sequence diagram](images/arch/sequence.png?raw=true)

# Building

Run using Spring:

	./gradlew :app-spring:bootJar

or Quarkus:

    ./gradlew publishToMavenLocal

	./mvnw clean compile quarkus:dev -f app-quarkus/pom.xml

Current Gradle support is not mature enough, so using Maven instead.

# Testing

## Unit/integration testing

One can find few unit tests that demonstrate some benefits of clean architecture for testing.

	./gradlew test

	./gradlew publishToMavenLocal

	./mvnw test -f app-quarkus/pom.xml

Integration testing of `app-spring-vaadin` is a bit tricky (one have to use commercial testing framework from Vaadin team [`Testbench`](https://vaadin.com/docs/testbench/testbench-overview.html) or 

make `Selenide` working with `TestContainers` instead).

## Manual testing

First, run the app from IDE or command line:

	./gradlew :app-spring:bootRun

![Application running](images/app/running.png?raw=true)

### URLs

Add a note by navigating to URL as follows `http://localhost:8080/api/add?title=title1&body=body1`:

![Add a note](images/app/add_note.png?raw=true)

List the notes by navigating to URL `http://localhost:8080/api/list`

![List the notes](images/app/list_notes.png?raw=true)

### Simple UI (Spring MVC + Thymeleaf)

Add a note at web page with URL `http://localhost:8080/app/add`:

![Add a note](images/app/add_note_ui1.png?raw=true)

Make sure you can see added note (forwarded after adding) `http://localhost:8080/app/list`

![List the notes](images/app/list_notes_ui1.png?raw=true)

### Simple UI (Vaadin)

Make sure you've installed the modules into local Maven repo:

	./gradlew publishToMavenLocal

Run the app from command line:

	./mvnw spring-boot:run -f app-spring-vaadin/pom.xml

Add a note at web page with URL `http://localhost:8080/app/add`:

![Add a note](images/app/add_note_ui2.png?raw=true)

Make sure you can see added note (forwarded after adding) `http://localhost:8080/app/list`

![List the notes](images/app/list_notes_ui2.png?raw=true)

# Frameworks and tools

* [Kotlin](https://kotlinlang.org/), [Kotlin/Native](https://kotlinlang.org/docs/reference/native-overview.html) programming language

* [Kotlin Multiplatform](https://kotlinlang.org/docs/reference/multiplatform.html) for multiplatform configuration/building

* [IntelliJ IDEA](https://www.jetbrains.com/idea/) IDE for coding

* [Gradle](https://gradle.org/) with Kotlin DSL for building

* [Maven](https://maven.apache.org/) for dependency management (for JVM clients, Quarkus and Vaadin)

* [CocoaPods](https://cocoapods.org/) for dependency management (for iOS/macOS clients)

* [ORMLite](http://ormlite.com/) ORM for persistence

* [H2](https://www.h2database.com/html/main.html) db engine for testing

* [Spring Web](https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html) for HTTP REST

* [Spring MVC](https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html) for Front end

* [Thymeleaf](https://www.thymeleaf.org/) for views templating

* [Vaadin](https://vaadin.com/) for Front end

* [Spring Boot](https://spring.io/projects/spring-boot) for bootstrapping

* [Quarkus](https://quarkus.io/) for AOT-compilation and bootstrapping

* [GraalVM](https://www.graalvm.org/) for AOT-compilation into native binaries with Quarkus

* [Google Protocol Buffers](https://developers.google.com/protocol-buffers) and [gRPC](https://grpc.io/) for RPC

* [Travis CI](https://travis-ci.org/) for CI

# Feedback

Any feedback and discussion is appreciated.

Contact me on e-mail for this or fork the repository and pull a request.

# Author

Anton Smirnov

dev [at] antonsmirnov [dot] name

2019