Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: YHT <yangheetae0827@naver.com>
  • Loading branch information
yht0827 authored Oct 24, 2024
1 parent a9562de commit f4e71a3
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,40 @@
# kfanboy
kfanboy project

## ๐Ÿš€ ํ”„๋กœ์ ํŠธ ๊ฐœ์š”
- `kfanboy`๋Š” K-pop ๊ด€๋ จํ•˜์—ฌ ํŒฌ ์ปค๋ฎค๋‹ˆํ‹ฐ ํ”Œ๋žซํผ ํ”„๋กœ์ ํŠธ์ž…๋‹ˆ๋‹ค.
- UI๋Š” ์นด์นด์˜ค ์˜ค๋ธ์œผ๋กœ ๋Œ€์ฒดํ•˜์—ฌ ํ”„๋ก ํŠธ์—”๋“œ ๋ถ€๋ถ„์€ ์ƒ๋žตํ•˜๊ณ  ๋ฒก์—”๋“œ์— ์ดˆ์ ์„ ๋งž์ถฐ `๋ฐฑ์—”๋“œ ๊ฐœ๋ฐœ`์— ์ฃผ๋ ฅํ–ˆ์Šต๋‹ˆ๋‹ค.
- ๊ธฐ๋Šฅ ๊ตฌํ˜„ํ•˜๋Š” ๊ฒƒ์—๋งŒ ๊ทธ์น˜์ง€ ์•Š๊ณ  ์–ด๋–ป๊ฒŒ ํ•˜๋ฉด `๋” ๋งŽ์€ ํŠธ๋ž˜ํ”ฝ`์„ ๊ฒฌ๋”œ ์ˆ˜ ์žˆ์„์ง€ ๊ณ ๋ฏผํ•˜๋ฉฐ ๊ฐœ๋ฐœํ–ˆ์Šต๋‹ˆ๋‹ค.
- ๊ฐ์ฒด ์ง€ํ–ฅ ์„ค๊ณ„ ์›์น™์„ ์ตœ๋Œ€ํ•œ ์ค€์ˆ˜ํ•˜๋ฉฐ ์ฝ”๋“œ์˜ `์žฌ์‚ฌ์šฉ์„ฑ` ๋ฐ `์œ ์ง€ ๋ณด์ˆ˜์„ฑ`์„ ๋†’์ผ ์ˆ˜ ์žˆ๋„๋ก ๋…ธ๋ ฅํ–ˆ์Šต๋‹ˆ๋‹ค.

## ๐Ÿ”น ํ”„๋กœ์ ํŠธ ๊ณ ๋ ค ์‚ฌํ•ญ
- `๋Œ€๊ทœ๋ชจ ํŠธ๋ž˜ํ”ฝ` ์‹œ ๋ฐœ์ƒํ•˜๋Š” `๋™์‹œ์„ฑ`, `ํŠธ๋žœ์žญ์…˜` ๋“ฑ์˜ ๋ฌธ์ œ๋ฅผ ๊ณ ๋ คํ•˜์—ฌ ์•ˆ์ •์ ์ธ ์„œ๋น„์Šค ๋ฐฉ๋ฒ•์„ ๊ณ ๋ คํ•ด๋ณด์•˜์Šต๋‹ˆ๋‹ค.
- ๋‚˜์œ ์ฝ”๋“œ์— ๋Œ€ํ•ด ์ง€์†์ ์œผ๋กœ `์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง` ์ง„ํ–‰ํ•˜์˜€์Šต๋‹ˆ๋‹ค.
- ๋Œ€๊ทœ๋ชจ ๋ฐ์ดํ„ฐ ๊ฒ€์ƒ‰ ์‹œ `์„ฑ๋Šฅ ๊ฐœ์„ ` ๋ฐฉ๋ฒ• ๊ณ ๋ คํ•ด๋ณด์•˜์Šต๋‹ˆ๋‹ค.
- ์„œ๋น„์Šค์˜ ๊ทœ๋ชจ๊ฐ€ ์ปค์ง€๊ณ  `ํŠธ๋ž˜ํ”ฝ์ด ์ฆ๊ฐ€`ํ•  ๋•Œ ์–ด๋–ป๊ฒŒ `๋ถ„์‚ฐํ•˜๊ณ  ๊ด€๋ฆฌ`ํ•  ์ˆ˜ ์žˆ๋Š”์ง€ ๊ณ ๋ฏผํ•˜๋ฉฐ ๊ฐœ๋ฐœํ•˜์˜€์Šต๋‹ˆ๋‹ค.
- ๋‹ค๋Ÿ‰์˜ ์š”์ฒญ ์ƒํ™ฉ์—์„œ ๋ณ‘๋ชฉํ˜„์ƒ์„ ์ฐพ์•„๋ณด๊ณ  ์›์ธ์„ ์ฐพ์•„ ํ•ด๊ฒฐํ•ด๋ณด๋Š” ๊ฒฝํ—˜์„ ํ•˜๊ธฐ ์œ„ํ•ด์„œ `๋ถ€ํ•˜ ํ…Œ์ŠคํŠธ`๋ฅผ ์ง„ํ–‰ํ•˜๊ณ  ๋‚ด๋ถ€์˜ ์ž์› ์ƒํ™ฉ์„ ๋ชจ๋‹ˆํ„ฐ๋งํ•ด๋ณด์•˜์Šต๋‹ˆ๋‹ค.
- `๊ฐ์ฒด์ง€ํ–ฅ์ ์œผ๋กœ ์ฝ”๋“œ`๋ฅผ ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ๋Š” ๋ฐฉ๋ฒ•์„ ํƒ๊ตฌํ•˜์˜€์Šต๋‹ˆ๋‹ค.
- Github Action์„ ์ด์šฉํ•ด์„œ `CI/CD ํ™˜๊ฒฝ`์„ ๊ตฌ์ถ•ํ•ด ๋ณด์•˜์Šต๋‹ˆ๋‹ค.

## ๐Ÿ“• ์‚ฌ์šฉ ๊ธฐ์ˆ 
- Spring Boot
- Java 17
- Gradle
- Nginx
- Naver Cloud Platform
- Docker
- JPA
- MYSQL
- Redis
- ELK

## โ˜๏ธ Architecture
![image](https://github.com/user-attachments/assets/30f23db5-eb86-4716-929d-dc92e6868666)


## ๐Ÿ“ WIKI
- [Prototype](https://github.com/yht0827/kfanboy/wiki/3.-%ED%99%94%EB%A9%B4-%EC%84%A4%EA%B3%84)
- [ERD](https://github.com/yht0827/kfanboy/wiki/1.-ERD-%EA%B5%AC%EC%A1%B0)
- [API Specification](https://github.com/yht0827/kfanboy/wiki/4.-%EA%B8%B0%EB%8A%A5-%EB%B0%8F-API-%EB%AA%85%EC%84%B8%EC%84%9C)
- [Architecture](https://github.com/yht0827/kfanboy/wiki/5.-Architecture)
- [ISSUE](https://github.com/yht0827/kfanboy/wiki/6.-%EC%9D%B4%EC%8A%88-%ED%95%B4%EA%B2%B0-%EA%B4%80%EB%A0%A8-%ED%8F%AC%EC%8A%A4%ED%8C%85)

0 comments on commit f4e71a3

Please sign in to comment.