diff --git a/docs/README.md b/docs/README.md index e69de29..5baaf77 100644 --- a/docs/README.md +++ b/docs/README.md @@ -0,0 +1,279 @@ +### ๐ฅ๏ธ ํ๋ก๊ทธ๋จ ์๊ฐ +์ฃผ๋ฌธ์ ๋ฐ์์ ์ด๋ฒคํธ ์ ์ฉ ๋ด์ญ์ ์ถ๋ ฅํ๋ ํ๋ก๊ทธ๋จ์ ๋๋ค. + +### ๐ก ํต์ฌ ๊ธฐ๋ฅ +์ ์ฉ ๊ฐ๋ฅํ ์ด๋ฒคํธ ํํ ๋ด์ญ ๊ณ์ฐ + +### ๐ ์ฃผ์ ํฌ์ธํธ +- ํ ์ธ ์ด๋ฒคํธ์ ์ ๋ฌผ ์ด๋ฒคํธ๋ฅผ ์ธํฐํ์ด์ค์ ์ถ์ ํด๋์ค๋ก ๋ถ๋ฆฌ์ ๋์์ ๊ณตํต ๋ก์ง ํตํฉ +- ์ฌ๋ฌ ์ข ๋ฅ์ ์ด๋ฒคํธ๋ฅผ Enum๊ณผ ํจ์ํ ์ธํฐํ์ด์ค๋ก ๊ด๋ฆฌ +- MVC ํจํด์ Service, Repository๋ฅผ ์ถ๊ฐํ์ฌ ์ญํ ๋ถ๋ฆฌ +- Enum๊ณผ EnumMap์ผ๋ก ๋ถํ์ ํด๋์ค ์ ๊ฑฐ ๋ฐ ํตํฉ ๊ด๋ฆฌ +- ๊ณ์ธตํ Dto๋ฅผ ํ์ฉํ View์ Domain ์์กด์ฑ ๋ถ๋ฆฌ + +### ๐ ๋ฐํ์ ์์กด๊ด๊ณ๋ + + +### ๐ UML + + +### โ๏ธ ํด๋์ค ์ญํ +
| ๐ Package | +๐ Class | +โ๏ธ Description | +
|---|---|---|
| ๐๏ธ config | +PlannerConfig | +์์กด๊ด๊ณ ์ค์ | +
| โ๏ธ controller | +OrderController | +์ฃผ๋ฌธ ์ ์ถ๋ ฅ(View), ์ฃผ๋ฌธ(Service) ์ฐ๊ฒฐ | +
| OrderConverter | +View ์ ๋ ฅ๊ฐ Order ์ธ์คํด์ค ๋ณ์๋ก ๋ณํ | +|
| ๐ domain ⇛ order |
+ Order | +์ฃผ๋ฌธ ์ผ์์ ๋ฉ๋ด ์๋์ ๊ฐ๋ ํด๋์ค | +
| Day | +12์์ ์ผ์ ์์ํ์ ํฌ์ฅ ํด๋์ค | +|
| domain ⇛ order ⇛ constant |
+ Category | +๋ฉ๋ด์ ์นดํ ๊ณ ๋ฆฌ Enum | +
| DayOfWeek | +์์ผ Enum | +|
| December | +12์ Enum | +|
| Menu | +๋ฉ๋ด Enum | +|
| Week | +ํ์ผ/์ฃผ๋ง Enum | +|
| domain ⇛ event |
+ ๐ Event | +์ด๋ฒคํธ ํํ ๊ณ์ฐ ์ธํฐํ์ด์ค | +
| ๐ EventRepository | +์ด๋ฒคํธ ํํ ๊ฒฐ๊ณผ ์ ์ฅ ์ถ์ ํด๋์ค | +|
| Badge | +๋ฐฐ์ง Enum | +|
| domain ⇛ event ⇛ discount |
+ ๐ DiscountEventType | +Event ์ธํฐํ์ด์ค ๊ตฌํ, ํ ์ธ ์ด๋ฒคํธ ํตํฉ ๊ด๋ฆฌ Enum | +
| ๐พ DiscountRepository | +EventRepository ๊ตฌํ, ํ ์ธ ์ด๋ฒคํธ ๊ฒฐ๊ณผ EnumMap ์ ์ฅ | +|
| domain ⇛ event ⇛ gift |
+ ๐ GiftEventType | +Event ์ธํฐํ์ด์ค ๊ตฌํ, ์ ๋ฌผ ์ด๋ฒคํธ ํตํฉ ๊ด๋ฆฌ Enum | +
| ๐พ GiftRepository | +EventRepository ๊ตฌํ, ์ ๋ฌผ ์ด๋ฒคํธ ๊ฒฐ๊ณผ EnumMap ์ ์ฅ | +|
| ๐น๏ธ service ⇛ order |
+ OrderService | +์ฃผ๋ฌธ ์์ฑ ๋ฐ ์ฃผ๋ฌธ ๊ฒฐ๊ณผ ์์ฝ | +
| service ⇛ event |
+ EventDetailService | +์ด๋ฒคํธ ์ ์ฉ ์์ธ ๊ฒฐ๊ณผ ์์ฝ | +
| ๐ EventService | +์ด๋ฒคํธ ํํ ๊ฒฐ๊ณผ ๊ณ์ฐ ์ถ์ ํด๋์ค | +|
| DiscountService | +EventService ๊ตฌํ, ํ ์ธ ํดํ ์ ์ฉ | +|
| GiftService | +EventService ๊ตฌํ, ์ ๋ฌผ ํดํ ์ ์ฉ | +|
| โฐ exception | +OrderException | +์ฃผ๋ฌธ ์์ฑ ์์ธ ๋ฐ์ | +
| ErrorMessage | +์์ธ ๋ฉ์์ง Enum | +|
| ๐ฌ response | +OrderSummaryResponse | +์ฃผ๋ฌธ ๊ฒฐ๊ณผ ์์ฝ DTO | +
| OrderResponse | +์ฃผ๋ฌธ ํญ๋ชฉ DTO | +|
| MenuCountResponse | +์ฃผ๋ฌธ ๋ฉ๋ด ์๋ DTO | +|
| EventDetailResponse | +์ด๋ฒคํธ ์ ์ฉ ์์ธ ๋ด์ญ DTO | +|
| EventResponse | +์ด๋ฒคํธ ์ ์ฉ ๋ด์ญ DTO | +|
| GiftMenuResponse | +์ ๋ฌผ ๋ฉ๋ด ์๋ DTO | +|
| ๐ฅ๏ธ view | +InputView | +์ ๋ ฅ ์์ฒญ View | +
| OutputView | +๊ฒฐ๊ณผ ์ถ๋ ฅ View | +|
| ๐ Reader | +์ ๋ ฅ ์ธํฐํ์ด์ค | +|
| ๐ Writer | +์ถ๋ ฅ ์ธํฐํ์ด์ค | +|
| view ⇛ io |
+ ConsoleReader | +์ฝ์ ์ ๋ ฅ | +
| ConsoleWriter | +์ฝ์ ์ถ๋ ฅ | +|