From 1738a7d3b665f0ef3fde08a7ce1edcb8cded07ad Mon Sep 17 00:00:00 2001
From: zenn <zenn.message@gmail.com>
Date: Wed, 22 Apr 2026 11:14:29 +0900
Subject: [PATCH] =?UTF-8?q?v0.1.24=20-=20=EA=B0=9C=EB=B0=9C=EC=9A=A9?=
 =?UTF-8?q?=EA=B3=BC=20=EB=B0=B0=ED=8F=AC=EC=9A=A9=20=EC=8B=A4=ED=96=89=20?=
 =?UTF-8?q?=EB=AC=B8=EC=84=9C=20=EC=B6=94=EA=B0=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 HANDOFF.md        |  4 +++-
 README.md         | 57 +++++++++++++++++++++++++++++++++++++++++++++++
 package-lock.json |  4 ++--
 package.json      |  2 +-
 4 files changed, 63 insertions(+), 4 deletions(-)
 create mode 100644 README.md

diff --git a/HANDOFF.md b/HANDOFF.md
index ba3ba2e..34a33a4 100644
--- a/HANDOFF.md
+++ b/HANDOFF.md
@@ -4,7 +4,7 @@
 
 - 프로젝트명: 10 Minute Planner 웹 UI
 - 기술 스택: Vue 3 + Vite + TailwindCSS + JavaScript
-- 현재 기준 버전: `v0.1.23` 준비 중
+- 현재 기준 버전: `v0.1.24` 준비 중
 - Git 원격 저장소: `https://git.sori.studio/zenn/planner.sori.studio.git`
 
 ## 기준 디자인
@@ -37,6 +37,7 @@
 - 프론트 Dockerfile: `Dockerfile`
 - 백엔드 Dockerfile: `backend/Dockerfile`
 - nginx 프록시 설정: `deploy/nginx/default.conf`
+- 실행 가이드 문서: `README.md`
 - Tailwind 설정은 완료되어 있으며, 이 프로젝트의 스타일링 기준으로 유지한다.
 - 현재 선택 날짜는 시스템 날짜 기준으로 시작한다.
 - `COMMENT`, `TASKS`, `MEMO`는 화면에서 바로 편집할 수 있다.
@@ -160,6 +161,7 @@
 - 비로그인 상태에서는 왼쪽 사이드 내비게이션을 숨기고, 중앙 로그인 안내 화면만 보여주도록 정리했다.
 - 배포용 `docker-compose.yml`과 별도로 개발용 `docker-compose.dev.yml`을 추가했다.
 - 개발용 compose는 프론트 `5173`, 백엔드 `3001`, PostgreSQL `5432`를 열고, 소스 마운트 + Vite HMR + Node watch 기반으로 자동 반영된다.
+- 개발/배포 실행 방법은 루트 `README.md`에 먼저 적고, `HANDOFF.md`에는 변경 이유와 주의사항 위주로 남긴다.
 - 비로그인 랜딩 카드는 상단 고정이 아니라 화면 중앙에 오도록 정렬을 수정했다.
 - 현재 환경에서는 Docker 데몬이 꺼져 있어서 `docker compose build` 실검증은 하지 못했고, 데몬 시작 후 다시 확인이 필요하다.
 - 이미지 저장 기능은 추후 `print-only` 또는 별도 export 전용 레이아웃을 기준으로 구현하면 화면/인쇄/공유 결과를 맞추기 쉽다.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1c6525a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+# 10 Minute Planner
+
+Vue 3 + TailwindCSS + Fastify + PostgreSQL 기반의 `10분 플래너 다이어리` 프로젝트다.
+
+## 실행 방법
+
+### 개발용
+
+코드를 수정하면서 자동 새로고침까지 보려면 개발용 compose를 사용한다.
+
+```bash
+docker compose -f docker-compose.dev.yml up
+```
+
+개발용 포트:
+
+- 프론트엔드: `http://localhost:5173`
+- 백엔드 API: `http://localhost:3001`
+- PostgreSQL: `localhost:5432`
+
+개발용 특징:
+
+- 프론트는 Vite HMR로 저장 즉시 화면이 반영된다.
+- 백엔드는 `node --watch`로 파일 변경 시 자동 재시작된다.
+- 즉, 개발 중에는 매번 새로 빌드할 필요 없이 `docker compose -f docker-compose.dev.yml up`만 켜두면 된다.
+
+### 배포용
+
+실서비스나 최종 확인용으로는 배포용 compose를 사용한다.
+
+```bash
+docker compose up -d --build
+```
+
+배포용 포트:
+
+- 프론트엔드: `http://localhost:8080`
+- PostgreSQL: `localhost:5432`
+
+배포용 특징:
+
+- 프론트는 빌드 결과물을 nginx로 서빙한다.
+- 브라우저에서는 `/api` 경로로 백엔드에 접근한다.
+- 수정 사항 반영 시에는 다시 빌드가 필요하다.
+
+## 문서
+
+- 작업 규칙: [`AGENTS.md`](./AGENTS.md)
+- 진행 상태 / 체크리스트: [`TODO.md`](./TODO.md)
+- 인수인계 메모: [`HANDOFF.md`](./HANDOFF.md)
+
+## 현재 방향
+
+- 기본 UX는 `1페이지 + 우측 정보 패널`
+- 보조 모드는 `2페이지 펼침 보기`
+- 스타일링은 Vue + TailwindCSS
+- 장기적으로는 Docker 기반으로 UGREEN NAS 배포 예정
diff --git a/package-lock.json b/package-lock.json
index ac036e3..b5ecbbf 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
   "name": "ten-minute-planner",
-  "version": "0.1.23",
+  "version": "0.1.24",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "ten-minute-planner",
-      "version": "0.1.23",
+      "version": "0.1.24",
       "dependencies": {
         "vue": "^3.5.13"
       },
diff --git a/package.json b/package.json
index ce985ec..6a7dd45 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "ten-minute-planner",
   "private": true,
-  "version": "0.1.23",
+  "version": "0.1.24",
   "type": "module",
   "scripts": {
     "dev": "vite",