From 50a107a3451d0f811aafd20f33252883c4f259a5 Mon Sep 17 00:00:00 2001 From: ParkJiYeoung8297 Date: Mon, 23 Feb 2026 17:10:10 +0900 Subject: [PATCH] docs: README update --- README.md | 198 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 194 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 83815dc8..d37b429a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,196 @@ -### version -- Spring Boot 3.5.9 -- JDK 21 +![img.png](img.png) + +![img_2.png](img_2.png) + +# ๐Ÿ“– ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ + +> **Real Match**๋Š” ๋ธŒ๋žœ๋“œ์™€ ๋งˆ์ดํฌ๋กœ ์ธํ”Œ๋ฃจ์–ธ์„œ๋ฅผ ์—ฐ๊ฒฐํ•˜๋Š” +> **๋งค์นญ ๋ฐ ํ˜‘์—… ๊ด€๋ฆฌ ํ”Œ๋žซํผ**์ž…๋‹ˆ๋‹ค. + +์ตœ๊ทผ ๋งˆ์ดํฌ๋กœ ์ธํ”Œ๋ฃจ์–ธ์„œ์˜ ์˜ํ–ฅ๋ ฅ์ด ํ™•๋Œ€๋˜๋ฉด์„œ ํ˜‘์—… ์ˆ˜์š”๋Š” ์ฆ๊ฐ€ํ•˜๊ณ  ์žˆ์ง€๋งŒ, +์—ฌ์ „ํžˆ ๋งŽ์€ ํ˜‘์—…์ด **DMยท์ด๋ฉ”์ผ ์ค‘์‹ฌ์˜ ๋น„์ •ํ˜•์ ์ธ ๋ฐฉ์‹**์œผ๋กœ ์ด๋ฃจ์–ด์ง€๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. + +--- + +## ๐ŸŽฏ Real Match๊ฐ€ ์ œ๊ณตํ•˜๋Š” ํ•ต์‹ฌ ๊ธฐ๋Šฅ + +- ๐Ÿ“Œ **๋งค์นญ ์•Œ๊ณ ๋ฆฌ์ฆ˜ ๊ธฐ๋ฐ˜ ์ถ”์ฒœ** +- ๐Ÿ“Š **๋งค์นญ ์ง„๋‹จ ๋Œ€์‹œ๋ณด๋“œ** +- ๐Ÿ“… **ํ˜‘์—… ์ƒํƒœ ์ถ”์  ๋ฐ ์ผ์ • ๊ด€๋ฆฌ ๋กœ์ง** +- ๐Ÿ’ฌ **์‹ค์‹œ๊ฐ„ ์ปค๋ฎค๋‹ˆ์ผ€์ด์…˜ ๋ฐ ์•Œ๋ฆผ ์‹œ์Šคํ…œ** + +--- + +Real Match๋Š” ์œ„ ๊ธฐ๋Šฅ์„ ํ†ตํ•ฉ ์ œ๊ณตํ•˜์—ฌ ๋ธŒ๋žœ๋“œ์™€ ์ธํ”Œ๋ฃจ์–ธ์„œ ๊ฐ„ ํ˜‘์—… ์ „ ๊ณผ์ •์„ +**ํ•˜๋‚˜์˜ ํ”Œ๋žซํผ์—์„œ ์ฒด๊ณ„์ ์œผ๋กœ ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ๋„๋ก ์„ค๊ณ„๋˜์—ˆ์Šต๋‹ˆ๋‹ค.** + +๋‹จ์ˆœ ๋งค์นญ์„ ๋„˜์–ด, + +> ๐Ÿ‘‰ **๋ฐ์ดํ„ฐ ๊ธฐ๋ฐ˜ ๋ถ„์„ + ํ˜‘์—… ํ”„๋กœ์„ธ์Šค ํ†ตํ•ฉ ๊ด€๋ฆฌ** + +๋ฅผ ํ†ตํ•ด ๋ณด๋‹ค ์ •๊ตํ•˜๊ณ  ํšจ์œจ์ ์ธ ๋ธŒ๋žœ๋“œ ๋งˆ์ผ€ํŒ… ํ™˜๊ฒฝ์„ ๊ตฌ์ถ•ํ•˜๋Š” ๊ฒƒ์„ ๋ชฉํ‘œ๋กœ ํ•ฉ๋‹ˆ๋‹ค. + +## ๐Ÿงฉ ์ฃผ์š” ๊ธฐ๋Šฅ + +| ๊ธฐ๋Šฅ | ์„ค๋ช… | +|------------------|-----------------------------| +| ๐Ÿ“ **๋งค์นญ ๊ฒ€์‚ฌ** | ๋งค์นญ ์•Œ๊ณ ๋ฆฌ์ฆ˜ ๊ธฐ๋ฐ˜ ๋ธŒ๋žœ๋“œ ์ถ”์ฒœ | +| ๐Ÿ”— **๋งค์นญ ์ง„๋‹จ ๋Œ€์‹œ๋ณด๋“œ** | ๋ธŒ๋žœ๋“œ ยท ์ธํ”Œ๋ฃจ์–ธ์„œ๊ฐ„์˜ ๋งค์นญ ํ˜„ํ™ฉ ๊ด€๋ฆฌ | +| ๐Ÿ“† **ํ˜‘์—… ์ผ์ • ๊ด€๋ฆฌ** | ์ผ์ • ๋ฐ ํ˜‘์—… ๊ด€๋ฆฌ ์บ˜๋ฆฐ๋” | +| ๐Ÿ“† **์‹ค์‹œ๊ฐ„ ์ฑ„ํŒ… ๊ธฐ๋Šฅ** | ๋ธŒ๋žœ๋“œยท์ธํ”Œ๋ฃจ์–ธ์„œ ๊ฐ„ ์‹ค์‹œ๊ฐ„ ๋ฉ”์‹œ์ง€ ๋ฐ ํŒŒ์ผ ๊ณต์œ  | +| ๐Ÿ” **๋ธŒ๋žœ๋“œ ยท ์บ ํŽ˜์ธ ๊ฒ€์ƒ‰** | ํ‚ค์›Œ๋“œ ๊ธฐ๋ฐ˜ ๋ธŒ๋žœ๋“œ ยท ์บ ํŽ˜์ธ ๊ฒ€์ƒ‰ | +| ๐Ÿ”” **์•Œ๋ฆผ ๊ธฐ๋Šฅ** | ๋งค์นญ, ์ผ์ • ๋ณ€๊ฒฝ, ํ˜‘์—… ์ƒํƒœ ์—…๋ฐ์ดํŠธ์— ๋Œ€ํ•œ ์‹ค์‹œ๊ฐ„ ์•Œ๋ฆผ (ํ‘ธ์‹œ/์ด๋ฉ”์ผ) | +| ๐Ÿ‘ค **ํšŒ์› ๊ด€๋ฆฌ** | JWT ๊ธฐ๋ฐ˜ ํšŒ์›๊ฐ€์ž… / ์†Œ์…œ ๋กœ๊ทธ์ธ | +| ๐Ÿ–ผ๏ธ **ํ”„๋กœํ•„ ๊ด€๋ฆฌ** | ๋งˆ์ดํŽ˜์ด์ง€์—์„œ ํ”„๋กœํ•„ ๋ฐ ๊ด€์‹ฌ์‚ฌ ์ˆ˜์ • | + +--- + +## ๐Ÿ› ์•„ํ‚คํ…์ณ ๊ตฌ์กฐ + +![img_3.png](img_3.png) + + +--- + +## ๐Ÿ‘ฉโ€๐Ÿ’ป RealMatch Spring Developers + +
+ +| | | | | | +|:-----------------------------------------------------------------------:|:----------------------------------------------------------------------------:|:------------------------------------------------------------------------:|:--------------------------------------------------------------------:|:-------------------------------------------------------------------------:| +| [**๊ณ ๊ฒฝ์ˆ˜**](https://github.com/lingard1234) | [**๋ฐ•์ง€์˜**](https://github.com/ParkJiYeoung8297) | [**์—ฌ์ฑ„ํ˜„**](https://github.com/1000hyehyang) | [**์ด์˜ˆ๋ฆผ**](https://github.com/yerimi00) | [**์ •์œค์ฒ **](https://github.com/Yoonchulchung) | +| `Backend Developer` | `Backend Developer / API Lead` | `Backend Developer` | `Backend Developer` | `Backend Developer / Algorithm Lead` | +| ๋กœ๊ทธ์ธ/ํšŒ์›๊ฐ€์ž…
๋งˆ์ดํŽ˜์ด์ง€ | ๋น„์ฆˆ๋‹ˆ์Šค (๋งค์นญ ยท ํ˜‘์—…)
์บ ํŽ˜์ธ | ์ฑ„ํŒ…
์•Œ๋ฆผ | ๋ธŒ๋žœ๋“œ | ๋งค์นญ ๊ฒ€์‚ฌ / ์•Œ๊ณ ๋ฆฌ์ฆ˜ | + +
+ + +## ๐Ÿ‘ฅ Detailed Responsibilities +

+๐Ÿ–ฑ๏ธ ์ขŒ์šฐ๋กœ ์Šคํฌ๋กคํ•ด์„œ ๋‚ด์šฉ์„ ํ™•์ธํ•ด์ฃผ์„ธ์š”. +

+
+ +
+ + + +### ๐Ÿ‘จโ€๐Ÿ’ป ๊ณ ๊ฒฝ์ˆ˜ +**Backend Developer** + +- Spring Security ๊ธฐ๋ฐ˜ ์ธ์ฆ/์ธ๊ฐ€ ๊ตฌํ˜„ +- JWT ํ† ํฐ ๋ฐœ๊ธ‰ ๋ฐ ๊ฒ€์ฆ ๋กœ์ง ๊ฐœ๋ฐœ +- ์‚ฌ์šฉ์ž ์ •๋ณด ๊ด€๋ฆฌ ๋ฐ ๋งˆ์ดํŽ˜์ด์ง€ API ๊ตฌํ˜„ +- Role ๊ธฐ๋ฐ˜ ์ ‘๊ทผ ์ œ์–ด ์ฒ˜๋ฆฌ + +
+ +
+ +### ๐Ÿ‘ฉโ€๐Ÿ’ป ๋ฐ•์ง€์˜ +**Backend Developer / API Lead** + +- ํ˜‘์—… ํ”Œ๋กœ์šฐ API ์„ค๊ณ„ ๋ฐ ๊ตฌํ˜„ (์ง€์› ยท ์ œ์•ˆ ยท ์ˆ˜๋ฝ ยท ๊ฑฐ์ ˆ) +- ์ƒํƒœ ์ „์ด ๊ธฐ๋ฐ˜ ๋„๋ฉ”์ธ ๋กœ์ง ์„ค๊ณ„ (์ œ์•ˆ โ†’ ์ˆ˜๋ฝ โ†’ ์ง„ํ–‰ โ†’ ์™„๋ฃŒ) +- QueryDSL ๊ธฐ๋ฐ˜ ํ˜‘์—… ์บ ํŽ˜์ธ ๊ฒ€์ƒ‰ ๋ฐ ํ•„ํ„ฐ๋ง ์ฒ˜๋ฆฌ +- ๋ธŒ๋žœ๋“œ-์บ ํŽ˜์ธ ์กฐํšŒ ๋ฐ ์ข‹์•„์š” ๊ธฐ๋Šฅ ๊ตฌํ˜„ +- Docker ๊ธฐ๋ฐ˜ CD ๊ตฌ์ถ• ๋ฐ ์„œ๋ฒ„ ๋ฐฐํฌ ์ž๋™ํ™” + +
+ +
+ +### ๐Ÿ‘ฉโ€๐Ÿ’ป ์—ฌ์ฑ„ํ˜„ +**Backend Developer** + +- WebSocket ๊ธฐ๋ฐ˜ ์‹ค์‹œ๊ฐ„ ์ฑ„ํŒ… ์‹œ์Šคํ…œ ๊ตฌํ˜„ +- STOMP ํ”„๋กœํ† ์ฝœ ๊ธฐ๋ฐ˜ ๋ฉ”์‹œ์ง€ ๋ธŒ๋กœ์ปค ๊ตฌ์„ฑ +- RabbitMQ ๊ธฐ๋ฐ˜ ๋น„๋™๊ธฐ ์•Œ๋ฆผ ์ด๋ฒคํŠธ ์ฒ˜๋ฆฌ +- Firebase ยท Email ์—ฐ๋™ ์•Œ๋ฆผ ์‹œ์Šคํ…œ ๊ตฌํ˜„ + +
+ +
+ +### ๐Ÿ‘ฉโ€๐ŸŽจ ์ด์˜ˆ๋ฆผ +**Backend Developer** + +- ๋ธŒ๋žœ๋“œ ๋„๋ฉ”์ธ CRUD API ์„ค๊ณ„ ๋ฐ ๊ตฌํ˜„ +- ๋ธŒ๋žœ๋“œ ๋ชฉ๋ก ยท ์ƒ์„ธ ยท ์š”์•ฝ ์กฐํšŒ API ๊ฐœ๋ฐœ +- ๋ธŒ๋žœ๋“œ ์ข‹์•„์š” ํ† ๊ธ€ ๋ฐ ํ˜‘์ฐฌ ์ œํ’ˆ ์กฐํšŒ ๊ธฐ๋Šฅ ๊ตฌํ˜„ + +
+ +
+ +### ๐Ÿ‘จโ€๐Ÿ’ป ์ •์œค์ฒ  +**Backend Developer / Algorithm Lead** + +- ์‚ฌ์šฉ์žยท์บ ํŽ˜์ธ ํƒœ๊ทธ ๊ธฐ๋ฐ˜ ๋งค์นญ ์ ์ˆ˜ ๊ณ„์‚ฐ ์•Œ๊ณ ๋ฆฌ์ฆ˜ ์„ค๊ณ„ +- ๋งค์นญ ์•Œ๊ณ ๋ฆฌ์ฆ˜ ๊ธฐ๋ฐ˜ ์ถ”์ฒœ API ์„ค๊ณ„ ๋ฐ ๊ตฌํ˜„ +- Redis ์บ์‹ฑ์„ ํ™œ์šฉํ•œ ์กฐํšŒ ์„ฑ๋Šฅ ๊ฐœ์„  +- Docker ๊ธฐ๋ฐ˜ ์„œ๋ฒ„ ํ™˜๊ฒฝ ๊ตฌ์„ฑ ๋ฐ CI ์ž๋™ํ™” ๊ตฌ์ถ• + +
+ +
+ +--- + +## ๐Ÿ“‚ Project Structure + +```yml +BE +โ”œโ”€โ”€ global (๊ณตํ†ต ์„ค์ •, ์˜ˆ์™ธ ์ฒ˜๋ฆฌ, ์œ ํ‹ธ ๋“ฑ) +โ””โ”€โ”€ user + โ”œโ”€โ”€ presentation (์™ธ๋ถ€์™€์˜ ์ ‘์ ) + โ”‚ โ”œโ”€โ”€ UserController.java + โ”‚ โ””โ”€โ”€ dto (ํ•ด๋‹น ๋„๋ฉ”์ธ ์ „์šฉ ๋ฐ์ดํ„ฐ ์ „์†ก ๊ฐ์ฒด) + โ”‚ โ”œโ”€โ”€ request + โ”‚ โ”‚ โ””โ”€โ”€ UserRequest.java + โ”‚ โ””โ”€โ”€ response + โ”‚ โ””โ”€โ”€ UserResponse.java + โ”œโ”€โ”€ application (๋น„์ฆˆ๋‹ˆ์Šค ๋กœ์ง์˜ ํ๋ฆ„ ์ œ์–ด) + โ”‚ โ””โ”€โ”€ service + โ”‚ โ”œโ”€โ”€ UserService.java (Interface) + โ”‚ โ””โ”€โ”€ UserServiceImpl.java + โ””โ”€โ”€ domain (ํ•ต์‹ฌ ๋น„์ฆˆ๋‹ˆ์Šค ๊ทœ์น™ ๋ฐ ์—”ํ‹ฐํ‹ฐ) + โ”œโ”€โ”€ entity + โ”‚ โ””โ”€โ”€ UserEntity.java + โ””โ”€โ”€ repository + โ””โ”€โ”€ UserRepository.java + +``` +--- + +## ๐Ÿ›  Tech Stack + +### Backend +- Spring Boot 3.5.9 +- Java 21 +- Spring Security (JWT, OAuth2) +- Spring Data JPA +- QueryDSL + +### Database +- MySQL +- Redis + +### Infra +- Docker / Docker Compose +- AWS EC2 +- AWS RDS +- AWS S3 / CloudFront + +### Communication +- WebSocket (์ฑ„ํŒ…) +- Firebase / Email (์•Œ๋ฆผ) +- RabbitMQ + +--- + +## ๐Ÿ“ ์ฝ”๋“œ ์ปจ๋ฒค์…˜ + ์•„๋ž˜ ๋ช…๋ น์–ด๋ฅผ ์ด์šฉํ•˜์—ฌ convention์„ ์ง€์ผœ์ฃผ์„ธ์š” ```bash @@ -16,5 +206,5 @@ git config core.hooksPath .githooks ```bash ./gradlew clean build -x test -docker-compose up --build -d# BE +docker-compose up --build -d # BE ```