diff --git a/docs/getting-started/quick-start.ko.md b/docs/getting-started/quick-start.ko.md index a6ed57d..af44556 100644 --- a/docs/getting-started/quick-start.ko.md +++ b/docs/getting-started/quick-start.ko.md @@ -8,7 +8,8 @@ ## 2. 설정 -앱을 PostgreSQL(선택적으로 Redis)에 연결한 뒤 플랫폼 설정을 지정합니다: +앱을 PostgreSQL(선택적으로 Redis)에 연결한 뒤, **`src/main/resources/application.yml`** 에 +플랫폼 설정을 지정합니다: ```yaml spring: diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md index 9ca806b..324eab7 100644 --- a/docs/getting-started/quick-start.md +++ b/docs/getting-started/quick-start.md @@ -8,7 +8,8 @@ See [Installation](installation.md). ## 2. Configure -Point the app at PostgreSQL (and optionally Redis), then set the platform knobs: +Point the app at PostgreSQL (and optionally Redis), then set the platform knobs — in +**`src/main/resources/application.yml`**: ```yaml spring: diff --git a/docs/getting-started/tutorial.ko.md b/docs/getting-started/tutorial.ko.md index 74ed54c..66acf9b 100644 --- a/docs/getting-started/tutorial.ko.md +++ b/docs/getting-started/tutorial.ko.md @@ -16,15 +16,27 @@ ## 1단계 — Spring Boot 프로젝트 만들기 최소 Spring Boot 4 프로젝트를 생성합니다([start.spring.io](https://start.spring.io)에서 Gradle + -Java 21 + Spring Boot 4.x). 또는 빈 폴더 `myapp/` 에 아래 두 파일만 만들어도 됩니다. +Java 21 + Spring Boot 4.x). 또는 빈 폴더 `myapp/` 에 아래 파일들을 직접 만들어도 됩니다. 완성 +구조는 다음과 같고, 각 단계마다 파일 내용 위에 **전체 경로**를 표시합니다: + +```text +myapp/ +├─ settings.gradle.kts +├─ build.gradle.kts +├─ compose.yaml +└─ src/ + └─ main/ + ├─ java/com/example/myapp/MyappApplication.java + └─ resources/application.yml +``` -**`settings.gradle.kts`** +**`myapp/settings.gradle.kts`** ```kotlin rootProject.name = "myapp" ``` -**`build.gradle.kts`** +**`myapp/build.gradle.kts`** ```kotlin plugins { @@ -65,7 +77,7 @@ dependencies { Gradle 래퍼가 없으면 추가하세요: `gradle wrapper` (또는 다른 Spring 프로젝트의 `gradlew` 복사). -메인 클래스도 필요합니다 — **`src/main/java/com/example/myapp/MyappApplication.java`**: +메인 클래스도 필요합니다 — **`myapp/src/main/java/com/example/myapp/MyappApplication.java`**: ```java package com.example.myapp; @@ -85,7 +97,7 @@ public class MyappApplication { ## 2단계 — Docker로 PostgreSQL 띄우기 -kit은 모든 것을 PostgreSQL에 저장합니다. 프로젝트 루트에 **`compose.yaml`** 생성: +kit은 모든 것을 PostgreSQL에 저장합니다. **`myapp/compose.yaml`** 생성: ```yaml services: @@ -106,7 +118,7 @@ services: ## 3단계 — 앱 설정 -**`src/main/resources/application.yml`** 생성: +**`myapp/src/main/resources/application.yml`** 생성: ```yaml spring: diff --git a/docs/getting-started/tutorial.md b/docs/getting-started/tutorial.md index 6d53247..92a5002 100644 --- a/docs/getting-started/tutorial.md +++ b/docs/getting-started/tutorial.md @@ -17,16 +17,28 @@ No prior knowledge of the kit is assumed. Every command and file is shown in ful ## Step 1 — Create a Spring Boot project Generate a minimal Spring Boot 4 project (e.g. at [start.spring.io](https://start.spring.io) -choose Gradle + Java 21 + Spring Boot 4.x), or just create these two files in an -empty folder `myapp/`. +choose Gradle + Java 21 + Spring Boot 4.x), or create the files below by hand in an +empty folder `myapp/`. By the end your project looks exactly like this — each file's full +path is shown above its contents in every step: + +```text +myapp/ +├─ settings.gradle.kts +├─ build.gradle.kts +├─ compose.yaml +└─ src/ + └─ main/ + ├─ java/com/example/myapp/MyappApplication.java + └─ resources/application.yml +``` -**`settings.gradle.kts`** +**`myapp/settings.gradle.kts`** ```kotlin rootProject.name = "myapp" ``` -**`build.gradle.kts`** +**`myapp/build.gradle.kts`** ```kotlin plugins { @@ -68,7 +80,7 @@ dependencies { Add the Gradle wrapper if you don't have one: `gradle wrapper` (or copy `gradlew` from any Spring project). -You also need a main class — **`src/main/java/com/example/myapp/MyappApplication.java`**: +You also need a main class — **`myapp/src/main/java/com/example/myapp/MyappApplication.java`**: ```java package com.example.myapp; @@ -88,7 +100,7 @@ public class MyappApplication { ## Step 2 — Start PostgreSQL with Docker -The kit stores everything in PostgreSQL. Create **`compose.yaml`** in the project root: +The kit stores everything in PostgreSQL. Create **`myapp/compose.yaml`**: ```yaml services: @@ -109,7 +121,7 @@ for you** when you run the app — you don't need to `docker compose up` yoursel ## Step 3 — Configure the app -Create **`src/main/resources/application.yml`**: +Create **`myapp/src/main/resources/application.yml`**: ```yaml spring: