Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kimzini authored Nov 28, 2024
1 parent 6e0d419 commit d3e57fa
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
## ๐Ÿง‘โ€๐Ÿ’ป R&R
| Profile | Name | Role |
|:---------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------:|:------------------------------------------------------------------------------------------------:|
| <a href="https://github.com/kimzini"><img src="https://avatars.githubusercontent.com/u/127485569?v=4" height="120px"></a> | ๊น€์ง„ํฌ<br> **kimzini** <br> FE |
| <a href="https://github.com/dvp-tae"><img src="https://avatars.githubusercontent.com/u/109207415?v=4" height="120px"></a> | ์„ฑํƒœํ˜„ <br> **dvp-tae** <br> FE |
| <a href="https://github.com/kimzini"><img src="https://avatars.githubusercontent.com/u/127485569?v=4" height="120px"></a> | ๊น€์ง„ํฌ<br> **kimzini** <br> FE | ์†Œ์…œ ๋กœ๊ทธ์ธ, ์˜จ๋ณด๋”ฉ, ๊ณต์—ฐ ์ƒ์„ธ, ๋งˆ์ด ํŽ˜์ด์ง€,<br> ํ‹ฐ์ผ“ ๋“ฑ๋ก ์„œ๋น„์Šค GUI ๊ฐœ๋ฐœ ๋ฐ API ์—ฐ๋™
| <a href="https://github.com/dvp-tae"><img src="https://avatars.githubusercontent.com/u/109207415?v=4" height="120px"></a> | ์„ฑํƒœํ˜„ <br> **dvp-tae** <br> FE | ์„œ๋น„์Šค ๋ฉ”์ธ, ๋ฆฌ๋ทฐ, ๋‘˜๋Ÿฌ๋ณด๊ธฐ,<br> ํด๋ผ์ฝ”๋ถ ๋งŒ๋“ค๊ธฐ ์„œ๋น„์Šค GUI ๊ฐœ๋ฐœ ๋ฐ API ์—ฐ๋™
| <a href="https://github.com/devkeon"><img src="https://avatars.githubusercontent.com/u/121371840?v=4" height="120px"></a> | \<๊ฐœ๋ฐœ ๋ฆฌ๋“œ><br>์ด๊ฑด <br> **devkeon** <br> BE | ์•„ํ‚คํ…์ฒ˜ ์„ค๊ณ„, ERD ์„ค๊ณ„, ๋ฉ”์ธ ์„œ๋ฒ„ ์ธํ”„๋ผ ๋ฐ CI/CD ๊ตฌ์ถ•, <br> ์ธ์ฆ/์ธ๊ฐ€, ๋ชจ๋‹ˆํ„ฐ๋ง ์‹œ์Šคํ…œ ๊ตฌ์ถ•, ํ‹ฐ์ผ“/๋ฆฌ๋ทฐ ๊ธฐ๋Šฅ,<br> ํด๋ผ์ฝ”๋ถ ๊ธฐ๋Šฅ, ํšŒ์› ๊ด€๋ จ ๊ธฐ๋Šฅ |
| <a href="https://github.com/anselmo228"><img src="https://avatars.githubusercontent.com/u/24919880?v=4" height="120px"></a> | ์ •ํฌ์ฐฌ <br> **anselmo** <br> BE | ERD ์„ค๊ณ„, AI ๋ฐ ๋ฐฐ์น˜ ์„œ๋ฒ„ ์ธํ”„๋ผ ๋ฐ CI/CD ๊ตฌ์ถ•, <br> ์ถ”์ฒœ AI ๋ชจ๋ธ ๊ตฌํ˜„, ๋ฐฐ์น˜ ๊ธฐ๋Šฅ(๋ฐ์ดํ„ฐ ๋กœ๋“œ) ๊ตฌ์ถ•, <br> ๊ณต์—ฐ ๊ธฐ๋Šฅ, ๊ณต์—ฐ ๋ฐ ํ‹ฐ์ผ“ ์ถ”์ฒœ ๊ธฐ๋Šฅ |

Expand All @@ -22,7 +22,11 @@
![architecture.png](./.github/readme-assets/architecture.png)

### PWA
- pwa ์‚ฌ์šฉ ์„ค๋ช…
- ๊ฐœ๋ฐœ ๋ฐ ์œ ์ง€๋ณด์ˆ˜ ๋น„์šฉ ์ ˆ๊ฐ
- ์‚ฌ์šฉ์ž๊ฐ€ ํ™ˆ ํ™”๋ฉด์— ์ถ”๊ฐ€ํ•˜์—ฌ ์•ฑ์ฒ˜๋Ÿผ ํ™œ์šฉ ๊ฐ€๋Šฅ
- ๋„ค์ดํ‹ฐ๋ธŒ ์•ฑ๊ณผ ์œ ์‚ฌํ•œ ์‚ฌ์šฉ์„ฑ๊ณผ ๋น ๋ฅธ ๋กœ๋”ฉ ์†๋„ ์ œ๊ณต
- ํ”Œ๋žซํผ ์ œ์•ฝ ์—†์ด ๋‹ค์–‘ํ•œ ํ™˜๊ฒฝ์—์„œ ๋™์ผํ•œ ์‚ฌ์šฉ์ž ๊ฒฝํ—˜ ์ œ๊ณต
- ์ถ”ํ›„ ์›น ํ‘ธ์‹œ ์•Œ๋ฆผ, ๋ฐฑ๊ทธ๋ผ์šด๋“œ ๋™์ž‘ ๋“ฑ ๊ธฐ๋Šฅ ํ™•์žฅ์ด ์šฉ์ด

### ๋ณด์•ˆ ๊ณ ๋ ค ์‚ฌํ•ญ
- JWT๋ฅผ ํ™œ์šฉํ•œ ์ธ์ฆ/์ธ๊ฐ€
Expand Down Expand Up @@ -73,12 +77,14 @@
| ๊ธฐ์ˆ  ์Šคํƒ | ์„ค๋ช… |
|-----------|------|
| React | React๋Š” ๊ฐ€์žฅ ํ•ต์‹ฌ ์š”์†Œ์ธ Virtual Dom์„ ์ด์šฉํ•˜์—ฌ ๋ถˆํ•„์š”ํ•œ ํ™”๋ฉด ๊ฐฑ์‹ ์„ ์ตœ์†Œํ™”ํ•ฉ๋‹ˆ๋‹ค. ์ด๋ฅผ ํ†ตํ•ด, ์„ฑ๋Šฅ ํ–ฅ์ƒ์„ ์‹œํ‚ฌ ์ˆ˜ ์žˆ์œผ๋ฉฐ ๋น ๋ฅธ ๋ Œ๋”๋ง์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค. React๋Š” ์ปดํฌ๋„ŒํŠธ ๊ธฐ๋ฐ˜ ์•„ํ‚คํ…์ฒ˜๋ฅผ ์ฑ„ํƒํ•˜๊ณ  ์žˆ์œผ๋ฉฐ, UI ์š”์†Œ๋“ค์„ ์ปดํฌ๋„ŒํŠธ๋กœ ๋ถ„๋ฆฌํ•˜์—ฌ ๊ฐœ๋ฐœํ•˜๊ณ  ์กฐํ•ฉํ•˜๋Š” ๋ฐฉ์‹์œผ๋กœ ๊ตฌ์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋”ฐ๋ผ์„œ, ์ปดํฌ๋„ŒํŠธ์˜ ์žฌ์‚ฌ์šฉ์„ฑ์„ ์šฉ์ดํ•˜๊ฒŒ ํ•˜๋ฉฐ, ์ฝ”๋“œ ์ˆ˜์ • ๋ฐ ์œ ์ง€ยท๋ณด์ˆ˜์— ํšจ์œจ์ ์ด๊ธฐ์— React๋ฅผ ์‚ฌ์šฉํ•˜๊ฒŒ ๋˜์—ˆ์Šต๋‹ˆ๋‹ค. |
| TypeScript | TypeScript๋Š” ์ •์  ํƒ€์ž… ์–ธ์–ด๋กœ, ์ฝ”๋“œ๋ฅผ ๋” ์•ˆ์ •์ ์œผ๋กœ ๋งŒ๋“ค๊ณ  ๊ฐœ๋ฐœ์ž ์‚ฌ์ด์˜ ํ˜‘์—…์„ ์šฉ์ดํ•˜๊ฒŒ ํ•ด์ค๋‹ˆ๋‹ค. ์ƒ์‚ฐ์„ฑ์ ‘๊ทผํŒŒ์ผ ๋‹จ๊ณ„์—์„œ ์—๋Ÿฌ๋ฅผ ๋ฐœ๊ฒฌํ•˜์—ฌ ๋Ÿฐํƒ€์ž„ ์˜ค๋ฅ˜๋ฅผ ๋ฐฉ์ง€ํ•˜๋ฉฐ, ์ฝ”๋“œ ํžŒํŠธ์™€ ์ž๋™ ์™„์„ฑ์„ ์ œ๊ณตํ•˜์—ฌ ๊ฐœ๋ฐœ ์ƒ์‚ฐ์„ฑ์„ ๋†’์—ฌ์ฃผ๋Š” ์žฅ์ ์ด ์žˆ์–ด TypeScript๋ฅผ ์„ ์ •ํ•˜๊ฒŒ ๋˜์—ˆ์Šต๋‹ˆ๋‹ค. |
| Zustand | ๊ฐ„๊ฒฐ์„ฑ๊ณผ ์œ ์—ฐ์„ฑ๊ฐ„๊ฒฐํ•˜๊ณ  ์ง๊ด€์ ์ธ ๋ณด์ผ๋Ÿฌํ”Œ๋ ˆ์ดํŠธ ๋ฐ ๊ฐœ๋ฐœ ๋ฐฉ์‹์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. ๋ถˆํ•„์š”ํ•œ ๋ Œ๋”๋ง ์ตœ์†Œํ™”์ƒํƒœ๊ฐ€ ๋ณ€๊ฒฝ๋  ๋•Œ๋งŒ ์ปดํฌ๋„ŒํŠธ๋ฅผ ๋ Œ๋”๋งํ•˜๋ฏ€๋กœ ๋ถˆํ•„์š”ํ•œ ๋ Œ๋”๋ง์„ ์ตœ์†Œํ™”ํ•  ์ˆ˜ ์žˆ์–ด ์„ฑ๋Šฅ ํ–ฅ์ƒ์— ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค. |
| Yarn | ๋†’์€ ์†๋„, ์•ˆ์ •์„ฑ ๋ฐ ๋ณด์•ˆ์„ฑYarn์€ JavaScript ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ €๋กœ, ๋น ๋ฅธ ์†๋„ ๋ฐ ๋†’์€ ์‹ ๋ขฐ์„ฑ๊ณผ ๋ณด์•ˆ์„ฑ์„ ์ œ๊ณตํ•˜์—ฌ ํšจ์œจ์ ์ธ ํ”„๋กœ์ ํŠธ ๊ด€๋ฆฌ๊ฐ€ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. |
| Tanstack-Query | ํšจ์œจ์ ์ธ Data Fetching ๋ฐ ๊ด€๋ฆฌ๋ฐ์ดํ„ฐ ์บ์‹ฑ ๋“ฑ์˜ ๊ธฐ๋Šฅ์„ ์กด์žฌํ•˜์—ฌ ๋ถˆํ•„์š”ํ•œ ๋ฐ์ดํ„ฐ ์š”์ฒญ์„ ์ค„์ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. |
| TypeScript | ์ •์  ํƒ€์ž… ์–ธ์–ด๋กœ์„œ ์ฝ”๋“œ์˜ ์•ˆ์ •์„ฑ์„ ๋†’์ด๊ณ  ํ˜‘์—…์„ ์šฉ์ดํ•˜๊ฒŒ ํ•˜๋ฉฐ, ์ƒ์‚ฐ์„ฑ ์ ‘๊ทผ ํŒŒ์ผ ๋‹จ๊ณ„์—์„œ ์˜ค๋ฅ˜๋ฅผ ์‚ฌ์ „์— ๋ฐœ๊ฒฌํ•˜์—ฌ ๋Ÿฐํƒ€์ž„ ์˜ค๋ฅ˜๋ฅผ ๋ฐฉ์ง€ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ, ์ฝ”๋“œ ํžŒํŠธ์™€ ์ž๋™ ์™„์„ฑ์„ ์ œ๊ณตํ•ด ๊ฐœ๋ฐœ ์ƒ์‚ฐ์„ฑ์„ ํ–ฅ์ƒ์‹œํ‚ฌ ์ˆ˜ ์žˆ์–ด TypeScript๋ฅผ ์„ ์ •ํ–ˆ์Šต๋‹ˆ๋‹ค. |
| Zustand | ๊ฐ„๊ฒฐํ•˜๊ณ  ์ง๊ด€์ ์ธ ์ƒํƒœ ๊ด€๋ฆฌ ๋ฐฉ์‹๊ณผ ์ตœ์†Œํ•œ์˜ ๋ณด์ผ๋Ÿฌํ”Œ๋ ˆ์ดํŠธ๋กœ ์œ ์—ฐ์„ฑ์„ ์ œ๊ณตํ•˜๋ฉฐ, ์ƒํƒœ ๋ณ€๊ฒฝ ์‹œ์—๋งŒ ์ปดํฌ๋„ŒํŠธ๋ฅผ ๋ Œ๋”๋งํ•˜์—ฌ ๋ถˆํ•„์š”ํ•œ ๋ Œ๋”๋ง์„ ์ตœ์†Œํ™”ํ•˜๊ณ  ์„ฑ๋Šฅ ํ–ฅ์ƒ์— ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค. |
| Yarn | ๋น ๋ฅธ ์†๋„์™€ ๋†’์€ ์‹ ๋ขฐ์„ฑ์„ ๋ฐ”ํƒ•์œผ๋กœ ์•ˆ์ •์ ์ธ JavaScript ํŒจํ‚ค์ง€ ๊ด€๋ฆฌ๋ฅผ ์ง€์›ํ•˜๋ฉฐ, ๋ณด์•ˆ์„ฑ ๊ฐ•ํ™” ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•˜์—ฌ ํšจ์œจ์ ์ธ ํ”„๋กœ์ ํŠธ ๊ด€๋ฆฌ๊ฐ€ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. |
| TailwindCSS | ๊ฐœ๋ฐœ์˜ ํŽธ์˜์„ฑ HTML๊ณผ CSS ํŒŒ์ผ์„ ๋ณ„๋„๋กœ ๊ฐœ๋ฐœ ๋ฐ ๊ด€๋ฆฌํ•  ํ•„์š”๊ฐ€ ์—†๊ธฐ ๋•Œ๋ฌธ์— ๊ฐœ๋ฐœํ•˜๊ธฐ์— ํŽธ๋ฆฌํ•˜๊ณ , ํŒ€ํ•‘ํ•˜๋Š” ๊ฐ ํƒœ๊ทธ์˜ ํด๋ž˜์Šค๋ช…์„ ๊ณ ๋ฏผํ•  ์‹œ๊ฐ„์„ ์ ˆ์•ฝํ•  ์ˆ˜ ์žˆ์–ด ๋น ๋ฅธ ๊ฐœ๋ฐœ์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. |
| Vercel | ๊ฐ„ํŽธํ•œ ๋ฐฐํฌ ์ž๋™ํ™” ๊ฐ€๋Šฅํ•˜์—ฌ์— ํ‘ธ์‹œํ•  ๋•Œ๋งˆ๋‹ค ์ž๋™ ๋ฐฐํฌํ•˜๋Š” ๋ฐฉ์‹์œผ๋กœ ๊ฐ„ํŽธํ•˜๊ฒŒ ์›น์‚ฌ์ดํŠธ๋ฅผ ๋ฐฐํฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. |
| shadcn/ui | TailwindCSS์™€์˜ ๊ธด๋ฐ€ํ•œ ํ†ตํ•ฉ์œผ๋กœ ๋น ๋ฅด๊ณ  ์ผ๊ด€๋œ ์Šคํƒ€์ผ๋ง์ด ๊ฐ€๋Šฅํ•˜๋ฉฐ, ๋†’์€ ํ™•์žฅ์„ฑ๊ณผ ์œ ์—ฐํ•œ ์ปค์Šคํ„ฐ๋งˆ์ด์ง• ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ํ”„๋กœ์ ํŠธ ์š”๊ตฌ์‚ฌํ•ญ์— ๋งž๋Š” UI๋ฅผ ํšจ์œจ์ ์œผ๋กœ ๊ตฌํ˜„ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. |
| Tanstack-Query | ํšจ์œจ์ ์ธ ๋ฐ์ดํ„ฐ ํŽ˜์นญ๊ณผ ๊ด€๋ฆฌ๋ฅผ ์ œ๊ณตํ•˜๋ฉฐ, ๋ฐ์ดํ„ฐ ์บ์‹ฑ ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ๋ถˆํ•„์š”ํ•œ ์š”์ฒญ์„ ์ค„์—ฌ ์„ฑ๋Šฅ ์ตœ์ ํ™”์™€ ๋„คํŠธ์›Œํฌ ๋น„์šฉ ์ ˆ๊ฐ์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. |
| Vercel | ๊นƒ ์ €์žฅ์†Œ์™€ ํ†ตํ•ฉ๋˜์–ด ์ฝ”๋“œ ๋ณ€๊ฒฝ ์‚ฌํ•ญ์„ ์ž๋™์œผ๋กœ ๊ฐ์ง€ํ•˜๊ณ , ํ‘ธ์‹œํ•  ๋•Œ๋งˆ๋‹ค ์ž๋™ ๋ฐฐํฌ๋ฅผ ์ง€์›ํ•˜์—ฌ ํšจ์œจ์ ์ด๊ณ  ๊ฐ„ํŽธํ•˜๊ฒŒ ์›น์‚ฌ์ดํŠธ๋ฅผ ๋ฐฐํฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. |
| PWA | ์›น ๊ธฐ์ˆ  ๊ธฐ๋ฐ˜์œผ๋กœ ๋‹ค์–‘ํ•œ ํ”Œ๋žซํผ์—์„œ ๋™์ž‘ํ•˜๊ณ , ์•ฑ ์Šคํ† ์–ด ์—†์ด ํ™ˆ ํ™”๋ฉด์— ์ถ”๊ฐ€ํ•  ์ˆ˜ ์žˆ์–ด ์ ‘๊ทผ์„ฑ๊ณผ ํŽธ์˜์„ฑ์ด ๋›ฐ์–ด๋‚˜๋ฉฐ, ๊ฐœ๋ฐœ ๋น„์šฉ ์ ˆ๊ฐ๊ณผ ๋น ๋ฅธ ๋ฐฐํฌ๊ฐ€ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. |

## ๐Ÿ—‚๏ธ Naming Rules
* ํด๋”๋ช… - `PascalCase`
Expand Down

0 comments on commit d3e57fa

Please sign in to comment.