Update README

whatever-mentoring · Apr 11, 2024 · 9e5a92e · 9e5a92e
1 parent 8d437ef
commit 9e5a92e
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+## 미르었던 다짐
+
+2024년 새해를 맞아 미루었던 다짐을 생성하고 다짐을 이루는데 도움을 주고자 하는 서비스입니다.
+
+설정한 다짐을 이뤄냈다면 기프티콘은 돌려받지만, 실패하면 내 다짐에 응원을 남긴 지인들에게 랜덤으로 돌려주는 서비스입니다.
+
+---
+
+## 인프라 구조
+
+![](docs/images/infra.png)
+
+---
+
+## 모듈 구조
+
+![](docs/images/module.png)
+
+---
+
+## R&R
+
+<table>
+    <td align="center"><a href="https://github.com/mkSpace"><img src="https://github.com/mkSpace.png" width="100px;" alt=""/><br /><sub><b>박재민</b></sub></a><br />💻</a></td>
+    <td align="center"><a href="https://github.com/K-Diger"><img src="https://github.com/K-Diger.png" width="100px;" alt=""/><br /><sub><b>김도현</b></sub></a><br />💻</a></td>
+  </tr>
+</table>
diff --git a/docs/images/infra.png b/docs/images/infra.png
diff --git a/docs/images/module.png b/docs/images/module.png
diff --git a/raisedragon-api/README.md b/raisedragon-api/README.md
@@ -0,0 +1,14 @@
+## 미르었던 다짐 API Module
+
+실제 사용자에게 API를 제공하는 모듈입니다.
+
+### 기술 스택
+
+- Spring Boot 3.0.4,
+- Kotlin 1.9
+- 
+
+### 참조 모듈
+- core
+- common
+- external
diff --git a/raisedragon-common/README.md b/raisedragon-common/README.md
@@ -0,0 +1,11 @@
+## 미르었던 다짐 Common Module
+
+공통된 관심사를 해결하는 Kotlin 모듈입니다.
+
+### 기술 스택
+
+- Kotlin 1.9
+
+### 기능
+
+- 예외 정의
diff --git a/raisedragon-core/README.md b/raisedragon-core/README.md
@@ -0,0 +1,9 @@
+## 미르었던 다짐 Core Module
+
+핵심 도메인과 비즈니스 로직을 관리하는 모듈입니다.
+
+### 기술 스택
+
+- Kotlin 1.9
+- Spring Data JPA
+- QueryDSL
diff --git a/raisedragon-external/README.md b/raisedragon-external/README.md
@@ -0,0 +1,8 @@
+## 미르었던 다짐 External Module
+
+외부 서비스와의 통신을 관리하기 위한 Kotlin 모듈입니다.
+
+### 기술 스택
+
+- Kotlin 1.9
+- AWS