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.png?size=120) | ![](https://github.com/kih00.png?size=120) | ![](https://github.com/Leafguyk.png?size=120) | -| [๊น€์šฉ๋ฒ”](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) |