{"id":42741621,"url":"https://github.com/4ntoine/notesserverapp","last_synced_at":"2026-01-29T19:00:29.994Z","repository":{"id":37262062,"uuid":"189477229","full_name":"4ntoine/NotesServerApp","owner":"4ntoine","description":"Notes server-side app (clean architecture)","archived":false,"fork":false,"pushed_at":"2022-06-20T22:43:21.000Z","size":2575,"stargazers_count":3,"open_issues_count":5,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-07-30T19:23:19.705Z","etag":null,"topics":["clean-architecture","grpc","kotlin","kotlin-multiplatform","rest-api"],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/4ntoine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-30T20:22:10.000Z","updated_at":"2020-09-08T12:41:24.000Z","dependencies_parsed_at":"2022-08-24T15:51:12.183Z","dependency_job_id":null,"html_url":"https://github.com/4ntoine/NotesServerApp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/4ntoine/NotesServerApp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4ntoine%2FNotesServerApp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4ntoine%2FNotesServerApp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4ntoine%2FNotesServerApp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4ntoine%2FNotesServerApp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/4ntoine","download_url":"https://codeload.github.com/4ntoine/NotesServerApp/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4ntoine%2FNotesServerApp/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28882598,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T16:41:59.663Z","status":"ssl_error","status_checked_at":"2026-01-29T16:39:39.641Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clean-architecture","grpc","kotlin","kotlin-multiplatform","rest-api"],"created_at":"2026-01-29T19:00:18.183Z","updated_at":"2026-01-29T19:00:29.982Z","avatar_url":"https://github.com/4ntoine.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/4ntoine/NotesServerApp.svg?branch=master)](https://travis-ci.org/4ntoine/NotesServerApp)\n\n# The project\n\n## Server-side\n\nThis 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.\n\n## Client-side\n\nCheck out according [client-side app(s)](https://github.com/4ntoine/NotesClientApp).\n`domain` and `app-api` are Kotlin Multiplatform modules.\nInstall them to local Maven repository for the JVM clients:\n\n    ./gradlew publishToMavenLocal\n\nGenerate CocoaPod specs for iOS clients (iOS simulator target only - `iosX64`):\n\n    ./gradlew podspec\n    \nNote: while Kotlin/Multiplatform is still experimental\n`-Xuse-experimental=kotlin.ExperimentalMultiplatform` compiler option is used.    \n\n# The motivation\n\nHere is a quick recap of the benefits that clean architecture brings:\n\n* Independent of Frameworks\n* Testable\n* Independent of UI\n* Independent of Database\n* Independent of any external agency\n\nYou can find few more README.md files in subdirectories.\n\n# Clean architecture implementation\n\nFind the classes in clean architecture diagram:\n\n![Clean architecture diagram](images/arch/my_clean_arch.png?raw=true)\n\n![Sequence diagram](images/arch/sequence.png?raw=true)\n\n# Building\n\nRun using Spring:\n\n\t./gradlew :app-spring:bootJar\n\nor Quarkus:\n\n    ./gradlew publishToMavenLocal\n\t./mvnw clean compile quarkus:dev -f app-quarkus/pom.xml\n\nCurrent Gradle support is not mature enough, so using Maven instead.\n\n# Testing\n\n## Unit/integration testing\n\nOne can find few unit tests that demonstrate some benefits of clean architecture for testing.\n\n\t./gradlew test\n\t./gradlew publishToMavenLocal\n\t./mvnw test -f app-quarkus/pom.xml\n\nIntegration 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 \nmake `Selenide` working with `TestContainers` instead).\n\n## Manual testing\n\nFirst, run the app from IDE or command line:\n\n\t./gradlew :app-spring:bootRun\n\n![Application running](images/app/running.png?raw=true)\n\n### URLs\n\nAdd a note by navigating to URL as follows `http://localhost:8080/api/add?title=title1\u0026body=body1`:\n\n![Add a note](images/app/add_note.png?raw=true)\n\nList the notes by navigating to URL `http://localhost:8080/api/list`\n\n![List the notes](images/app/list_notes.png?raw=true)\n\n### Simple UI (Spring MVC + Thymeleaf)\n\nAdd a note at web page with URL `http://localhost:8080/app/add`:\n\n![Add a note](images/app/add_note_ui1.png?raw=true)\n\nMake sure you can see added note (forwarded after adding) `http://localhost:8080/app/list`\n\n![List the notes](images/app/list_notes_ui1.png?raw=true)\n\n### Simple UI (Vaadin)\n\nMake sure you've installed the modules into local Maven repo:\n\n\t./gradlew publishToMavenLocal\n\nRun the app from command line:\n\n\t./mvnw spring-boot:run -f app-spring-vaadin/pom.xml\n\nAdd a note at web page with URL `http://localhost:8080/app/add`:\n\n![Add a note](images/app/add_note_ui2.png?raw=true)\n\nMake sure you can see added note (forwarded after adding) `http://localhost:8080/app/list`\n\n![List the notes](images/app/list_notes_ui2.png?raw=true)\n\n# Frameworks and tools\n\n* [Kotlin](https://kotlinlang.org/), [Kotlin/Native](https://kotlinlang.org/docs/reference/native-overview.html) programming language\n* [Kotlin Multiplatform](https://kotlinlang.org/docs/reference/multiplatform.html) for multiplatform configuration/building\n* [IntelliJ IDEA](https://www.jetbrains.com/idea/) IDE for coding\n* [Gradle](https://gradle.org/) with Kotlin DSL for building\n* [Maven](https://maven.apache.org/) for dependency management (for JVM clients, Quarkus and Vaadin)\n* [CocoaPods](https://cocoapods.org/) for dependency management (for iOS/macOS clients)\n* [ORMLite](http://ormlite.com/) ORM for persistence\n* [H2](https://www.h2database.com/html/main.html) db engine for testing\n* [Spring Web](https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html) for HTTP REST\n* [Spring MVC](https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html) for Front end\n* [Thymeleaf](https://www.thymeleaf.org/) for views templating\n* [Vaadin](https://vaadin.com/) for Front end\n* [Spring Boot](https://spring.io/projects/spring-boot) for bootstrapping\n* [Quarkus](https://quarkus.io/) for AOT-compilation and bootstrapping\n* [GraalVM](https://www.graalvm.org/) for AOT-compilation into native binaries with Quarkus\n* [Google Protocol Buffers](https://developers.google.com/protocol-buffers) and [gRPC](https://grpc.io/) for RPC\n* [Travis CI](https://travis-ci.org/) for CI\n\n# Feedback\n\nAny feedback and discussion is appreciated.\nContact me on e-mail for this or fork the repository and pull a request.\n\n# Author\n\nAnton Smirnov\n\ndev [at] antonsmirnov [dot] name\n\n2019","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F4ntoine%2Fnotesserverapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F4ntoine%2Fnotesserverapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F4ntoine%2Fnotesserverapp/lists"}