From a9af5c0baa48c8549456e2503980e3bb48b521ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EA=B9=80=ED=98=84=EC=A3=BC?= Date: Thu, 17 Jul 2025 16:56:03 +0900 Subject: [PATCH] =?UTF-8?q?=EA=B0=81=20=EB=AA=A8=EB=93=88=EC=9D=98=20?= =?UTF-8?q?=EB=82=B4=EB=B6=80=20=EA=B5=AC=EC=A1=B0(=ED=97=A5=EC=82=AC?= =?UTF-8?q?=EA=B3=A0=EB=82=A0=20=EC=95=84=ED=82=A4=ED=85=8D=EC=B2=98=20?= =?UTF-8?q?=EC=98=88=EC=8B=9C)=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 287b1ef1..27bddca8 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,11 @@ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. ``` +## 프로젝트 개요 + +본 프로젝트는 **헥사고날 아키텍처(Ports & Adapters)** 기반의 Spring Boot 멀티모듈 시스템입니다. +도메인 로직과 외부 시스템(웹, DB, 파일 등)을 명확히 분리하여 유지보수성과 확장성을 극대화하였습니다. + ## Prerequisites * JDK 17+ @@ -43,14 +48,6 @@ recycle 은 `core` 모듈을 기반으로 한 `admin`, `front`, `api` 어플리 | |-- pom.xml | |-- src | `-- target -|-- api # API 모듈 (JWT 토큰 기반 인증) -| |-- pom.xml -| |-- src -| `-- target -|-- aws # AWS 서비스 전략(strategy) 모듈 -| |-- pom.xml -| |-- src -| `-- target |-- core # 공통 모듈 | |-- pom.xml | |-- src @@ -60,6 +57,7 @@ recycle 은 `core` 모듈을 기반으로 한 `admin`, `front`, `api` 어플리 | |-- src | `-- target `-- pom.xml +`-- README.md ``` ⚡ AWS S3 업로드를 이용하지 않는다면, pom.xml 에서 `aws`모듈 관련 내용을 삭제하면 된다. @@ -72,6 +70,26 @@ recycle 의 demo 가 궁금하다면 아래 URL 에서 확인 해주세요. - `recycle-api` - https://recycle-api.etribe.co.kr/swagger-ui/index.html - `recycle-front` - https://recycle-front.etribe.co.kr/ 계정정보 (generalUser/generalUser1@#$) +### 각 모듈의 내부 구조(헥사고날 아키텍처 예시) + +``` +usecase/ + └── daily/ + └── expense/ + ├── ports/ + │ ├── application/ + │ │ └── DailyExpenseService.java + │ ├── DailyExpensePortIn.java + │ └── DailyExpensePortOut.java + └── adapters/ + ├── persistence/ + │ └── DailyExpenseDao.java + └── web/ + └── DailyExpenseController.java +``` +- **ports/**: 도메인 서비스 및 인터페이스(Port) +- **adapters/**: 외부 시스템(웹, DB 등) 연결 어댑터 + ## VM Options