From 7820af5f24c97459861cae743eef9f38dd9aa365 Mon Sep 17 00:00:00 2001
From: Yongbeom Kim <96988554+Criminal0627@users.noreply.github.com>
Date: Sat, 1 Feb 2025 21:51:13 +0900
Subject: [PATCH] Update README.md
---
README.md | 96 ++++++++++++++++++++++++++++++++++++++++++++++++-------
1 file changed, 84 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 13c0e01..7b68ccd 100644
--- a/README.md
+++ b/README.md
@@ -11,8 +11,30 @@
-## ๐ ์๊ฐ
-ํ๊ทธ๋ฅผ ํ์ฉํ์ฌ ๊ฐํธํ๊ฒ ๋งค๋ชจ๋ฅผ ์์ฑํ๋ ์ฑ์
๋๋ค.
+## ๐MemoWithTags
+# MemoWithTags
+
+**MemoWithTags**๋ ๊ธฐ์กด์ ๋๋ ํฐ๋ฆฌ ๊ธฐ๋ฐ ๋ฉ๋ชจ ๊ด๋ฆฌ ๋ฐฉ์์ ํํผํ์ฌ, **ํ๊ทธ ๊ธฐ๋ฐ์ ์ ์ฐํ ๋ฉ๋ชจ ๊ด๋ฆฌ**์ **AI ๊ธฐ๋ฐ ํ๊ทธ ์ถ์ฒ** ๊ธฐ๋ฅ์ ํตํด ์ฌ์ฉ์๊ฐ ๋์ฑ ํจ์จ์ ์ผ๋ก ์ ๋ณด๋ฅผ ๋ถ๋ฅํ๊ณ ๊ฒ์ํ ์ ์๋๋ก ๋์์ฃผ๋ ํ์ ์ ์ธ ๋ฉ๋ชจ ์ฑ์
๋๋ค.
+
+---
+
+## ์ฃผ์ ํน์ง
+
+ **ํ๊ทธ ๊ธฐ๋ฐ ๋ฉ๋ชจ ๊ด๋ฆฌ**
+ ๊ธฐ์กด์ ํด๋๋ ๋๋ ํฐ๋ฆฌ ๋ฐฉ์๊ณผ ๋ฌ๋ฆฌ, ๋ฉ๋ชจ๋ง๋ค ์์ ๋กญ๊ฒ ํ๊ทธ๋ฅผ ๋ถ์ฌํ ์ ์์ด ๋ค์ํ ๊ด์ ์์ ๋ฉ๋ชจ๋ฅผ ๋ถ๋ฅํ๊ณ ๊ฒ์ํ ์ ์์ต๋๋ค.
+
+**AI ์๋ ํ๊ทธ ์ถ์ฒ**
+ ๋ฉ๋ชจ ์์ฑ ์ AI๊ฐ ํต์ฌ ๋ด์ฉ์ ๋ถ์ํ์ฌ ์ ์ ํ ํ๊ทธ๋ฅผ ์๋์ผ๋ก ์ถ์ฒํด์ค๋๋ค. ๋๋ถ์ ์ฌ์ฉ์๋ ๋์ฑ ๋น ๋ฅด๊ฒ ๋ฉ๋ชจ๋ฅผ ์ ๋ฆฌํ๊ณ , ์ค์ํ ์ ๋ณด๋ฅผ ๋์น์ง ์์ ์ ์์ต๋๋ค.
+
+**์ง๊ด์ ์ธํฐํ์ด์ค**
+ ์ฌ์ฉ์ ๊ฒฝํ์ ๊ทน๋ํํ ๋์์ธ๊ณผ ๊ฐํธํ ์ธํฐํ์ด์ค๋ฅผ ์ ๊ณตํ์ฌ ๋ณต์กํ ๋ถ๋ฅ ์ฒด๊ณ ์์ด๋ ์ํ๋ ๋ฉ๋ชจ๋ฅผ ์ฆ์ ์ฐพ์ ์ ์์ต๋๋ค.
+
+**ํจ์จ์ ์ธ ๊ฒ์ ๊ธฐ๋ฅ**
+ ํ๊ทธ ๊ธฐ๋ฐ ๊ฒ์๊ณผ ํค์๋ ํํฐ๋ง ๊ธฐ๋ฅ์ ํตํด ์๋ง์ ๋ฉ๋ชจ ์์์๋ ์ํ๋ ์ ๋ณด๋ฅผ ๋น ๋ฅด๊ฒ ์กฐํํ ์ ์์ต๋๋ค.
+
+ **๋ง์ถคํ ์ํฌํ๋ก์ฐ ์ง์**
+ ๊ฐ์ธ์ ์
๋ฌด ์คํ์ผ์ ๋ง๊ฒ ํ๊ทธ๋ฅผ ์ปค์คํฐ๋ง์ด์งํ๊ณ , ๋ฉ๋ชจ๋ฅผ ์์ ๋กญ๊ฒ ์ฐ๊ฒฐํ ์ ์์ด ์ฐฝ์์ ์ธ ์์ด๋์ด ์ ๋ฆฌ์ ์ต์ ํ๋์ด ์์ต๋๋ค.
+
@@ -24,8 +46,64 @@
-## ๐๏ธ APIs
-์์ฑํ API๋ ์๋์์ ํ์ธํ ์ ์์ต๋๋ค.
+## ์ฐ๋ฆฌ ์กฐ์ ์๋ํ ๊ฑฐ๋ฆฌ
+
+
+# ๐ ์ฃผ์ ๊ธฐ๋ฅ
+
+MemoWithTags๋ ํ๊ทธ ๊ธฐ๋ฐ ๋ฉ๋ชจ ๊ด๋ฆฌ์ AI ์๋ ํ๊ทธ ์ถ์ฒ์ ํตํด ํจ์จ์ ์ธ ๋ฉ๋ชจ ์ ๋ฆฌ๋ฅผ ์ง์ํ๋ ์๋น์ค์
๋๋ค.
+์๋๋ ์ ๊ณต๋๋ ์ฃผ์ ๊ธฐ๋ฅ๊ณผ API ์๋ํฌ์ธํธ์
๋๋ค.
+
+---
+
+## ๐ **์ธ์ฆ (Auth)**
+- **ํ์๊ฐ์
** โ `POST /auth/register`
+- **์ด๋ฉ์ผ ์ธ์ฆ** โ `POST /auth/verify-email`
+- **๋ก๊ทธ์ธ** โ `POST /auth/login`
+- **๋น๋ฐ๋ฒํธ ์ฌ์ค์ ** โ `POST /auth/reset-password`
+- **๋น๋ฐ๋ฒํธ ๋ณ๊ฒฝ** โ `PUT /auth/password`
+- **๋๋ค์ ์์ ** โ `PUT /auth/nickname`
+- **ํ ํฐ ์ฌ๋ฐ๊ธ** โ `POST /auth/refresh-token`
+- **์ฌ์ฉ์ ์ ๋ณด ์กฐํ** โ `GET /auth/me`
+- **ํ์ ํํด** โ `DELETE /auth/withdrawal`
+
+---
+
+## ๐ **๋ฉ๋ชจ (Memo)**
+- **๋ฉ๋ชจ ์์ฑ** โ `POST /memo`
+- **๋ฉ๋ชจ ์์ ** โ `PUT /memo/{memoId}`
+- **๋ฉ๋ชจ ์ญ์ ** โ `DELETE /memo/{memoId}`
+- **๋ฉ๋ชจ ๊ฒ์** โ `GET /search-memo`
+- **๋ฉ๋ชจ์ ํ๊ทธ ์ถ๊ฐ** โ `POST /memo/{memo-id}/tag`
+- **๋ฉ๋ชจ์์ ํ๊ทธ ์ญ์ ** โ `DELETE /memo/{memo-id}/tag`
+
+---
+
+## ๐ท **ํ๊ทธ (Tag)**
+- **์ ์ฒด ํ๊ทธ ๊ฐ์ ธ์ค๊ธฐ** โ `GET /tag`
+- **ํ๊ทธ ์์ฑ** โ `POST /tag`
+- **ํ๊ทธ ์์ ** โ `PUT /tag/{tagId}`
+- **ํ๊ทธ ์ญ์ ** โ `DELETE /tag/{tagId}`
+
+---
+
+## ๐ **์์
๋ก๊ทธ์ธ (Social)**
+- **์นด์นด์ค ๋ก๊ทธ์ธ** โ `GET /auth/login/kakao`
+- **๋ค์ด๋ฒ ๋ก๊ทธ์ธ** โ `GET /oauth/naver`
+- **๊ตฌ๊ธ ๋ก๊ทธ์ธ** โ `GET /oauth/google`
+
+---
+
+## โ๏ธ **๊ด๋ฆฌ์ ๊ธฐ๋ฅ (Admin)**
+- **์ ์ ๋ชฉ๋ก ์กฐํ** โ `GET /admin/user`
+- **์ ์ ๊ณ์ ์์ฑ** โ `POST /admin/user`
+
+---
+
+์ด API ๋ชฉ๋ก์ ํตํด MemoWithTags์ ์ฃผ์ ๊ธฐ๋ฅ์ ํ๋์ ํ์ธํ ์ ์์ต๋๋ค.
+๋์ฑ ์ง๊ด์ ์ธ ํ๊ทธ ๊ธฐ๋ฐ ๋ฉ๋ชจ ๊ด๋ฆฌ์ AI ์๋ ํ๊ทธ ์ถ์ฒ ๊ธฐ๋ฅ์ ํตํด ์์ฐ์ฑ์ ๋์ฌ๋ณด์ธ์! ๐
+
+
๐๐ป [API ๋ฐ๋ก๋ณด๊ธฐ](/backend/APIs.md)
@@ -62,13 +140,7 @@
## ๐ค ๊ธฐ์ ์ ์ด์์ ํด๊ฒฐ ๊ณผ์
-- Stream ์จ์ผํ ๊น?
- - [Stream API์ ๋ํ์ฌ](https://velog.io/@yewo2nn16/Java-Stream-API)
-- Gmail STMP ์ด์ฉํ์ฌ ์ด๋ฉ์ผ ์ ์กํ๊ธฐ
- - [gmail ๋ณด๋ด๊ธฐ](https://velog.io/@yewo2nn16/Email-์ด๋ฉ์ผ-์ ์กํ๊ธฐwith-์ฒจ๋ถํ์ผ)
-- AWS EC2์ ๋ฐฐํฌํ๊ธฐ
- - [์๋ฒ ๋ฐฐํฌํ๊ธฐ-1](https://velog.io/@yewo2nn16/SpringBoot-์๋ฒ-๋ฐฐํฌ)
- - [์๋ฒ ๋ฐฐํฌํ๊ธฐ-2](https://velog.io/@yewo2nn16/SpringBoot-์๋ฒ-๋ฐฐํฌ-์ธํ
๋ฆฌ์ ์ด์์-jar-ํ์ผ-๋น๋ํด์-๋ฐฐํฌํ๊ธฐ)
+- ์์
๋ก๊ทธ์ธ
@@ -82,4 +154,4 @@
| AI ๊ฐ๋ฐ | User ๊ฐ๋ฐ | Memo & Tag ๊ฐ๋ฐ |
|:-------------------------------------------------:|:------------------------------------------:|:---------------------------------------------:|
|  |  |  |
-| [๊น์ฉ๋ฒ](https://github.com/Criminal0627) | [๊น์ธํธ](https://github.com/kih00) | [์ด์ข
ํธ](https://github.com/Leafguyk) |
\ No newline at end of file
+| [๊น์ฉ๋ฒ](https://github.com/Criminal0627) | [๊น์ธํธ](https://github.com/kih00) | [์ด์ข
ํธ](https://github.com/Leafguyk) |