docs: expand README + document sample-app purpose#39
Merged
Conversation
Replace the pre-0.1.0 scaffold README with a real one: drop the bookrecord reference and the speculative 'planned module layout', fix Java 25 -> 21, list the actual 17 modules, add the Maven Central install snippet (kr.devslab:devslab-kit-spring-boot-starter), a quick-start, the cache, and a pointer to the companion devslab-kit-admin-ui console. English + Korean.
README (en + ko): a full OSS README rather than the scaffold one — - badges (Maven Central, build, license, Java 21, Spring Boot 4), - a feature table, requirements, install (Gradle/Maven), - a quick-start, a full devslab.kit.* configuration reference table, - the module map (+ the -api/-core split), the admin REST API surface, - the companion admin-ui, design principles, build-from-source, and the lib-major = SB-major versioning note. sample-app: a new bilingual README explaining why the module exists — primarily the integration test harness (boots the full auto-configuration against real Postgres + Redis via Testcontainers; CI depends on it), plus a living reference config and the local-dev / GraalVM-native target. Documents that `bootRun` auto-starts compose.yaml via spring-boot-docker-compose, and that the module is excluded from publishing by design.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces the pre-0.1.0 scaffold README with a full OSS README and documents the sample-app.
README (en + ko)
devslab.kit.*configuration reference table (tenant / identity / audit / menu / cache / bootstrap, with defaults).-api/-coresplit, the admin REST API surface, the companion admin-ui, design principles, build-from-source, and thelib major = SB majorversioning note.bookrecordmention, "planned module layout", and the wrong "Java 25".sample-app README (new, en + ko)
Answers "what is this module for": primarily the integration test harness (boots the full auto-configuration against real Postgres + Redis via Testcontainers — CI depends on it), plus a living reference config and the local-dev / GraalVM-native target. Notes that
bootRunauto-startscompose.yamlviaspring-boot-docker-compose, and that it's excluded from publishing by design.Docs-only; no source changes.