From 7c4dde1f5e6e3686b791f3137d0ebefd2a0f7c32 Mon Sep 17 00:00:00 2001
From: Kim SeungHwan <69035864+kseysh@users.noreply.github.com>
Date: Sun, 26 Nov 2023 05:58:27 +0900
Subject: [PATCH] Update README.md
---
README.md | 67 +++++++++++++++++++++++++++++++++++++++----------------
1 file changed, 48 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
index 48c1b5d..9f6c986 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,3 @@
-# SOPKATHON-33-Server
-
> 33th DO SOPT SOPKATHON :: **re:ing**
>
> 33기 솝커톤 iOS 1조 프로젝트
@@ -72,16 +70,15 @@
| RDS 세팅 | `승환🤖` | 완료 |
| CI/CD 세팅 | `동규🍣` | 완료 |
| README 작성 | `동규🍣` | 완료 |
-| DB 설계 | `승환🤖` `동규🍣` | 진행 중 |
-| API 명세서 작성 | `승환🤖` `동규🍣` | 진행 예정 |
-| API 개발 | `승환🤖` `동규🍣` | 진행 예정 |
+| DB 설계 | `승환🤖` `동규🍣` | 완료 |
+| API 명세서 작성 | `승환🤖` `동규🍣` | 완료 |
+| API 개발 | `승환🤖` `동규🍣` | 완료 |
### ⭐️ 우리 사랑하기로 했어요 ⭐️
-(Comming Soon....)
-
+
@@ -103,17 +100,14 @@
---
> 자세한 테이블 정보는 다음 노션 페이지에 정리해둘 예정입니다! (Comming Soon...)
-- [📝 Database](Comming Soon...)
+- [📝 Database](https://www.notion.so/DB-Schema-Description-d0c91546b233435e908a1a2ab315295b?pvs=4)
-
+
## 🖇 Api 명세서
----
-> 작성 중
-
[🍀 API 명세서](https://www.notion.so/342f6504080f4113afb4a89af506c2d7?v=a36becbc1f0f4239a802053bf782195c&pvs=4)
@@ -121,24 +115,59 @@
## ⚙️ Architecture
---
-
+
## 🗂️ Project Foldering
-- **도메인 별로 Architecture를 나눌 예정입니다.**
```
+├── 📁 .github
+│ ├── 📁 ISSUE_TEMPLATE
+| └── 📁 workflows
+| └── pull_request_template.md
+│
+├── appspec.yml
+|
+├── HELP.md
+|
+├── build.gradle
+├── gradlew
+├── gradlew.bat
+|
+├── README.md
+|
+├── 📁 script
+│ ├── start.sh
+│ └── stop.sh
+└── 📁 src
+ └── 📁 main
+ ├── 📁 java
+ │ └── 📁 org
+ │ └── 📁 sopt
+ │ └── 📁 sopkerton
+ │ ├── SopkertonApplication.java
+ │ └── 📁 common
+ │ ├── 📁 exception
+ │ │ ├── GlobalError.java
+ │ │ ├── GlobalException.java
+ │ │ ├── GlobalSuccess.java
+ │ │ └── 📁 base
+ │ │ ├── ErrorBase.java
+ │ │ ├── ExceptionBase.java
+ │ │ ├── RootEnum.java
+ │ │ └── SuccessBase.java
+ │ └── 📁 response
+ │ ├── ApiResponse.java
+ │ └── CommonControllerAdvice.java
+ └── 📁 resources
+ └── application.yml
```
## ♻️ 실행 방법
-
----
-
-
-
+clone 받아서 application run하고 localhost:8080으로 api 명세서대로 api를 호출한다.