Skip to content

Commit db0d8a8

Browse files
Merge branch 'feature/#99' into develop
2 parents 40648bf + efe10a7 commit db0d8a8

File tree

1 file changed

+156
-1
lines changed

1 file changed

+156
-1
lines changed

โ€ŽREADME.mdโ€Ž

Lines changed: 156 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,156 @@
1-
![์Šคํ„ฐ๋”” 1](https://github.com/user-attachments/assets/670fc103-bf06-46e6-817f-643c0c9d4d8d)
1+
# Kiring: ํšŒ์‚ฌ ์ƒํ™œ์˜ ์—ฐ๊ฒฐ๊ณ ๋ฆฌ
2+
3+
![๋Œ€ํ‘œ ์ด๋ฏธ์ง€](https://github.com/user-attachments/assets/03dbb6af-f9f8-4ef0-ac03-566c5cb59b0e)
4+
5+
์˜ค๋Š˜ ์ ์‹ฌ์—๋Š” ๋ฌด์—‡์„ ๋จน์„์ง€, ์ผ์ •์„ ํ•œ ๋ˆˆ์— ํ™•์ธํ•  ์ˆ˜ ์—†์„์ง€, ํ‡ด๊ทผ์€ ๋˜ ์–ด๋–ป๊ฒŒ ํ• ์ง€.. ํšŒ์‚ฌ์›์ด๋ผ๋ฉด ํ•œ๋ฒˆ ์ฏค ํ•ด๋ณธ ๊ณ ๋ฏผ๋“ค์ž…๋‹ˆ๋‹ค.
6+
7+
ํ‚ค๋ง์€ **ํšŒ์‚ฌ ๊ทผ์ฒ˜ ์‹๋‹น ๋ฆฌ์ŠคํŠธ, ๊ตํ†ต ์ •๋ณด, ์บ˜๋ฆฐํ„ฐ, ์ปค๋ฎค๋‹ˆํ‹ฐ ๊ธฐ๋Šฅ ๋“ฑ ํšŒ์‚ฌ ์ƒํ™œ์— ํ•„์š”ํ•œ ์ •๋ณด๋ฅผ ํ†ตํ•ฉํ•˜์—ฌ ํ•œ ๊ณณ์—์„œ ์ œ๊ณต**ํ•˜๋Š” ๊ฒƒ์„ ๋ชฉํ‘œ๋กœ ํ–ˆ์Šต๋‹ˆ๋‹ค.
8+
9+
ํšŒ์‚ฌ ์ƒํ™œ์„ ๋”์šฑ ํŽธ๋ฆฌํ•˜๊ฒŒ ๋งŒ๋“ค์–ด์ฃผ๋Š” ์˜ฌ์ธ์› ํ”Œ๋žซํผ ํ‚ค๋ง์—์„œ, ์œ ์šฉํ•œ ์ •๋ณด๋ฅผ ์‰ฝ๊ณ  ๋น ๋ฅด๊ฒŒ ํ™•์ธํ•ด๋ณด์„ธ์š”!
10+
11+
<br />
12+
13+
## 1๏ธโƒฃ ํ”„๋ก ํŠธ์—”๋“œ ๊ธฐ์ˆ  ์Šคํƒ
14+
15+
![FE ๊ธฐ์ˆ  ์Šคํƒ](https://github.com/user-attachments/assets/5745aff1-cc34-4833-9768-856faf1546b3)
16+
17+
| **์Šคํƒ** | **๋ฒ„์ „** | **์„ ์ • ์ด์œ  ๋ฐ ํšจ๊ณผ** |
18+
| ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
19+
| **Next.js** | 15.3.1 | ยท ์„œ๋ฒ„ ์‚ฌ์ด๋“œ ๋ Œ๋”๋ง๊ณผ ์ •์  ์‚ฌ์ดํŠธ ์ƒ์„ฑ์„ ๋ชจ๋‘ ์ง€์›ํ•ด ์„ฑ๋Šฅ์ด ๋›ฐ์–ด๋‚˜๋ฉฐ, App Routes๋ฅผ ํ†ตํ•ด ๋ณด์•ˆ์ด ํ•„์š”ํ•œ API Key๋„ ์•ˆ์ „ํ•˜๊ฒŒ ์„œ๋ฒ„ ์ธก์—์„œ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์žˆ์—ˆ์Šต๋‹ˆ๋‹ค. <br /> ยท ์ž๋™ ์ตœ์ ํ™”์™€ ๋น ๋ฅธ ๊ฐœ๋ฐœ ์‚ฌ์ดํด, Vercel๊ณผ์˜ ์›ํ™œํ•œ ํ†ตํ•ฉ์œผ๋กœ ๋Œ€๊ทœ๋ชจ ์„œ๋น„์Šค์— ์ ํ•ฉํ•œ ํ™•์žฅ์„ฑ๊ณผ ์œ ์ง€๋ณด์ˆ˜์„ฑ์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. |
20+
| **Tailwind CSS** | 4.0.0 | ยท ๋‚ฎ์€ ๋Ÿฌ๋‹์ปค๋ธŒ๋กœ ๋น ๋ฅธ UI ๊ฐœ๋ฐœ์ด ๊ฐ€๋Šฅํ•˜๊ณ , ๋””์ž์ธ ํ† ํฐ๊ณผ ์—ฐ๋™ํ•ด ์Šคํƒ€์ผ์„ ์ค‘์•™์—์„œ ๊ด€๋ฆฌ๋ฆฌํ•˜๊ณ  ๋””์ž์ธ ์‹œ์Šคํ…œ์˜ ์ผ๊ด€์„ฑ์„ ์‰ฝ๊ฒŒ ์œ ์ง€ํ•  ์ˆ˜ ์žˆ์—ˆ์Šต๋‹ˆ๋‹ค. |
21+
| **TypeScript** | 5.0.0 | ยท ๋ช…ํ™•ํ•œ ํƒ€์ž… ์ •์˜๋กœ ๋Ÿฐํƒ€์ž„ ์˜ค๋ฅ˜๋ฅผ ์ค„์ด๊ณ , ๋ณต์žกํ•œ ์ƒํƒœ ๊ด€๋ฆฌ์™€ API ์—ฐ๋™ ์‹œ ์•ˆ์ •์„ฑ์„ ๋†’์—ฌ ์œ ์ง€๋ณด์ˆ˜๊ฐ€ ์šฉ์ดํ•ฉ๋‹ˆ๋‹ค. |
22+
| **Zustand** | 5.0.5 | ยท npm ํŠธ๋ Œ๋“œ๊ฐ€ ๋†’๊ณ  ๊พธ์ค€ํžˆ ์—…๋ฐ์ดํŠธ๊ฐ€ ๋˜๊ณ  ์žˆ์œผ๋ฉฐ, ๋Ÿฌ๋‹์ปค๋ธŒ๊ฐ€ ๋‚ฎ์€ ์žฅ์ ์ด ์žˆ์Šต๋‹ˆ๋‹ค. <br /> ยท ์ตœ์†Œํ•œ์˜ ์ฝ”๋“œ๋กœ ๋น ๋ฅด๊ฒŒ ์ƒํƒœ ๊ด€๋ฆฌ๋ฅผ ๊ตฌํ˜„ํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ, ๊ฒฝ๋Ÿ‰ ๊ตฌ์กฐ์™€ ๋†’์€ ์„ฑ๋Šฅ, ๋ชจ๋“ˆํ™”๋œ ์Šคํ† ์–ด๋กœ ํ™•์žฅ์„ฑ๊นŒ์ง€ ๊ณ ๋ คํ•  ์ˆ˜ ์žˆ์—ˆ์Šต๋‹ˆ๋‹ค. |
23+
| **Tanstack-Query** | 5.74.4 | ยท ์„œ๋ฒ„ ์ƒํƒœ๋ฅผ ์ž๋™์œผ๋กœ ๋™๊ธฐํ™”ํ•˜๊ณ , ์บ์‹ฑยท๋ฐฑ๊ทธ๋ผ์šด๋“œ ๊ฐฑ์‹ ยท์—๋Ÿฌ ์ฒ˜๋ฆฌ ๋“ฑ ๋ณต์žกํ•œ ๋ฐ์ดํ„ฐ ํŒจ์นญ ๋กœ์ง์„ ๊ฐ„๊ฒฐํ•˜๊ฒŒ ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ์–ด API ํ˜ธ์ถœ์„ ํšจ์œจ์ ์œผ๋กœ ์ตœ์ ํ™”ํ•  ์ˆ˜ ์žˆ์—ˆ์Šต๋‹ˆ๋‹ค. |
24+
25+
<br />
26+
27+
## 2๏ธโƒฃ ์ฃผ์š” ๊ตฌํ˜„ ์ „๋žต
28+
29+
### ๐Ÿ“ฑ ๋ฐฐํฌ ์ž๋™ํ™” ๋ฐ PWA ์ ์šฉ
30+
31+
![CI/CD, PWA](https://github.com/user-attachments/assets/94f9a3af-05db-48d0-912f-9beb214c3d65)
32+
33+
#### **โ˜‘๏ธ ์ž๋™ ๋™๊ธฐํ™” ๋ฐ ๋ฐฐํฌ ํ๋ฆ„**
34+
35+
- ๋ณ„๋„์˜ ์ˆ˜๋™ ๋™๊ธฐํ™” ์—†์ด GitHub Actions๋ฅผ ํ™œ์šฉํ•ด fork๋œ ๋ฐฐํฌ์šฉ ๋ ˆํฌ์ง€ํ† ๋ฆฌ๋ฅผ ์›๋ณธ๊ณผ ์ž๋™์œผ๋กœ ๋™๊ธฐํ™”ํ•˜๋ฉฐ, Vercel๊ณผ ์—ฐ๋™๋œ CI/CD ํŒŒ์ดํ”„๋ผ์ธ์„ ํ†ตํ•ด Preview ๋ฐ Production ๋ฐฐํฌ๊ฐ€ ์›ํ™œํ•˜๊ฒŒ ์ด๋ฃจ์–ด์ง‘๋‹ˆ๋‹ค.
36+
37+
#### **โ˜‘๏ธ ๋ฐฐํฌ์šฉ ๋ ˆํฌ์ง€ํ† ๋ฆฌ์™€ Vercel ์—ฐ๋™**
38+
39+
- develop ๋ธŒ๋žœ์น˜์— ๋ณ€๊ฒฝ์‚ฌํ•ญ์ด ๋ณ‘ํ•ฉ๋˜๋ฉด Preview ํ™˜๊ฒฝ(kiring-develop.vercel.app)์— ๋ฐฐํฌ๋˜์–ด ๊ฐœ๋ฐœ ์‹œ ์‹ค์‹œ๊ฐ„ ๊ฒ€์ฆ์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.
40+
41+
- ์ดํ›„ PR์„ ํ†ตํ•ด main ๋ธŒ๋žœ์น˜์— ๋ณ‘ํ•ฉ๋˜๋ฉด Production ํ™˜๊ฒฝ(kiring.vercel.app)์— ์ตœ์ข… ๋ฐฐํฌ๋ฅผ ์ž๋™์œผ๋กœ ์ˆ˜ํ–‰ํ•ฉ๋‹ˆ๋‹ค.
42+
43+
#### **โ˜‘๏ธ PWA(Progressive Web App) ์ ์šฉ**
44+
45+
- ๋ชจ๋ฐ”์ผ ํ™˜๊ฒฝ์—์„œ๋„ ๋„ค์ดํ‹ฐ๋ธŒ ์•ฑ๊ณผ ๊ฐ™์€ ์ง๊ด€์ ์ด๊ณ  ๋น ๋ฅธ ์‚ฌ์šฉ์ž ๊ฒฝํ—˜์„ ์ œ๊ณตํ•˜๊ธฐ ์œ„ํ•ด PWA๋ฅผ ๋„์ž…ํ–ˆ์Šต๋‹ˆ๋‹ค.
46+
47+
- ์ด๋ฅผ ํ†ตํ•ด ์‚ฌ์šฉ์ž๋Š” ๋ณ„๋„ ์•ฑ ์„ค์น˜ ์—†์ด๋„ ํ™ˆ ํ™”๋ฉด์— ์•ฑ ์•„์ด์ฝ˜ ์ถ”๊ฐ€, ์˜คํ”„๋ผ์ธ ์ ‘๊ทผ ๋“ฑ ์•ฑ ์ˆ˜์ค€์˜ ํŽธ๋ฆฌํ•œ ๊ธฐ๋Šฅ์„ ํ™œ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
48+
49+
<br />
50+
51+
### ๐ŸŽจ ๋””์ž์ธ ์‹œ์Šคํ…œ ๊ตฌํ˜„ ๋ฐ ์ž๋™ํ™”
52+
53+
![๋””์ž์ธ ์‹œ์Šคํ…œ ์ž๋™ํ™”](https://github.com/user-attachments/assets/8ed16f5d-d478-406c-b0be-dc3eb1b6a6a5)
54+
55+
- ๋””์ž์ธ ์‹œ์Šคํ…œ์„ ๊ตฌ์ถ•ํ•˜๊ณ  Figma์˜ Style Dictionary๋กœ ๊ด€๋ฆฌํ•œ ๋””์ž์ธ ํ† ํฐ(JSON)์„ Tailwind์— ์—ฐ๋™ํ–ˆ์Šต๋‹ˆ๋‹ค.
56+
57+
- ๋””์ž์ธ ์‹œ์Šคํ…œ์—์„œ ์ •์˜ํ•œ ์Šคํƒ€์ผ ๊ฐ’์ด ์ฝ”๋“œ์— ์ž๋™์œผ๋กœ ๋ฐ˜์˜๋˜์–ด, UI์˜ ์ผ๊ด€์„ฑ์„ ์‰ฝ๊ฒŒ ์œ ์ง€ํ•  ์ˆ˜ ์žˆ๊ณ  ๋””์ž์ธ ๋ณ€๊ฒฝ ์‹œ์—๋„ ๋ชจ๋“  ํ™”๋ฉด์— ์‹ ์†ํ•˜๊ฒŒ ์ ์šฉ๋˜์–ด ๊ฐœ๋ฐœ๊ณผ ์œ ์ง€๋ณด์ˆ˜์˜ ํšจ์œจ์„ฑ์ด ๋†’์•„์กŒ์Šต๋‹ˆ๋‹ค.
58+
59+
<br />
60+
61+
### ๐Ÿงฉ ์ปดํฌ๋„ŒํŠธ ๊ธฐ๋ฐ˜ UI ๊ตฌ์กฐํ™”
62+
63+
![UI ์ปดํฌ๋„ŒํŠธ](https://github.com/user-attachments/assets/d9d296eb-a623-481f-a77a-323ba18cf0a7)
64+
65+
- ๋ฐ˜๋ณต์ ์œผ๋กœ ์‚ฌ์šฉ๋˜๋Š” UI ์š”์†Œ๋ฅผ ์ปดํฌ๋„ŒํŠธ๋กœ ๋ถ„๋ฆฌํ•˜์—ฌ, ์ฝ”๋“œ์˜ ์ค‘๋ณต์„ ์ค„์ด๊ณ  UI ๊ตฌ์กฐ๋ฅผ ๋ช…ํ™•ํ•˜๊ฒŒ ํ™•๋ฆฝํ–ˆ์Šต๋‹ˆ๋‹ค.
66+
67+
- ๋˜ํ•œ ๋‹ค์–‘ํ•œ ์ƒํ™ฉ์—์„œ๋„ ์žฌ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋„๋ก props ๊ธฐ๋ฐ˜์œผ๋กœ ์„ค๊ณ„ํ•˜์—ฌ, ์œ ์—ฐ์„ฑ๊ณผ ํ™•์žฅ์„ฑ์„ ๋†’์˜€์Šต๋‹ˆ๋‹ค.
68+
69+
<br />
70+
71+
### โšก ์ธํ„ฐ๋ž™ํ‹ฐ๋ธŒ UI ๊ตฌํ˜„
72+
73+
![์ธํ„ฐ๋ž™ํ‹ฐ๋ธŒ UI](https://github.com/user-attachments/assets/d845571c-cd4d-45c8-94cf-c14ce4a1e694)
74+
75+
- ์‚ฌ์šฉ์ž๊ฐ€ ์„œ๋น„์Šค ์ด์šฉ ๊ณผ์ •์—์„œ ๋” ๋งŽ์€ ์žฌ๋ฏธ์™€ ๋ชฐ์ž…๊ฐ์„ ๋А๋‚„ ์ˆ˜ ์žˆ๋„๋ก, ๋‹ค์–‘ํ•œ ์ธํ„ฐ๋ž™ํ‹ฐ๋ธŒ UI ์š”์†Œ๋ฅผ ๋„์ž…ํ–ˆ์Šต๋‹ˆ๋‹ค.
76+
77+
- ์‚ฌ์šฉ์ž์™€์˜ ์ ๊ทน์ ์ธ ์ƒํ˜ธ์ž‘์šฉ์„ ์œ ๋„ํ•˜์—ฌ ์„œ๋น„์Šค ๊ฒฝํ—˜์ด ๋”์šฑ ์ƒ๋™๊ฐ ์žˆ๊ณ  ์ฆ๊ฑฐ์› ๋‹ค๋Š” ๊ธ์ •์ ์ธ ํ”ผ๋“œ๋ฐฑ์„ ๋ฐ›์„ ์ˆ˜ ์žˆ์—ˆ์Šต๋‹ˆ๋‹ค.
78+
79+
<br />
80+
81+
## 3๏ธโƒฃ ํ˜‘์—… ๊ณผ์ •
82+
83+
### ๐Ÿ—ƒ๏ธ Github์„ ์ด์šฉํ•œ ๊ฐœ๋ฐœ ๊ณผ์ • ๋ฌธ์„œํ™”
84+
85+
![ํ˜‘์—…1: Github](https://github.com/user-attachments/assets/dcba8364-c333-4d8d-af4b-fba6d39892f8)
86+
87+
<br />
88+
89+
### ๐Ÿฐ ์ฝ”๋“œ ๋ฆฌ๋ทฐ AI ๋„์ž…
90+
91+
![ํ˜‘์—…2: ์ฝ”๋“œ๋ฆฌ๋ทฐ AI](https://github.com/user-attachments/assets/71c95a0b-6d9d-4fb5-a99b-4a289ddbed66)
92+
93+
<br />
94+
95+
### ๐Ÿ“” Notion์„ ์ด์šฉํ•œ ๋กœ๋“œ๋งต ๊ด€๋ฆฌ
96+
97+
![ํ˜‘์—…3: Notion](https://github.com/user-attachments/assets/6394a73b-1b42-41fc-badb-dcb9a9163213)
98+
99+
<br />
100+
101+
## 4๏ธโƒฃ ์ฃผ์š” ๊ธฐ๋Šฅ
102+
103+
### ๐Ÿ” ์†Œ์…œ ๋กœ๊ทธ์ธ
104+
105+
![์†Œ์…œ ๋กœ๊ทธ์ธ ์ด๋ฏธ์ง€](https://github.com/user-attachments/assets/e81c4725-0c10-4840-bce7-1208523ce170)
106+
107+
<br />
108+
109+
### ๐Ÿ  ํ™ˆ
110+
111+
![๋ฉ”์ธ ํŽ˜์ด์ง€ ์ด๋ฏธ์ง€](https://github.com/user-attachments/assets/8cb0f297-1824-4b56-9862-283af192a6ca)
112+
113+
<br />
114+
115+
### ๐Ÿด ํ”Œ๋ ˆ์ด์Šค
116+
117+
![ํ”Œ๋ ˆ์ด์Šค ํŽ˜์ด์ง€ ์ด๋ฏธ์ง€](https://github.com/user-attachments/assets/344666c5-a2a7-4194-88cd-3b841a1d3709)
118+
119+
<br />
120+
121+
### ๐Ÿš ๊ตํ†ต
122+
123+
![๊ตํ†ต ํŽ˜์ด์ง€ ์ด๋ฏธ์ง€](https://github.com/user-attachments/assets/c216fe28-4893-4511-8816-33a05948a2d7)
124+
125+
<br />
126+
127+
### ๐Ÿ“… ์บ˜๋ฆฐ๋”
128+
129+
![์บ˜๋ฆฐ๋” ํŽ˜์ด์ง€ ์ด๋ฏธ์ง€](https://github.com/user-attachments/assets/cf47f2c1-fcf9-45fc-906a-c3fa9ef51f35)
130+
131+
<br />
132+
133+
### ๐Ÿ’ฌ ์ปค๋ฎค๋‹ˆํ‹ฐ
134+
135+
![์ปค๋ฎค๋‹ˆํ‹ฐ ํŽ˜์ด์ง€ ์ด๋ฏธ์ง€](https://github.com/user-attachments/assets/52fda276-6f09-431c-8448-5a103c19b127)
136+
137+
<br />
138+
139+
### ๐Ÿ’Œ ์ข…์ด๋น„ํ–‰๊ธฐ
140+
141+
![์ข…์ด๋น„ํ–‰๊ธฐ ํŽ˜์ด์ง€ ์ด๋ฏธ์ง€](https://github.com/user-attachments/assets/b4fecb2c-d0b2-4a92-b3fd-850d0d4eb279)
142+
143+
<br />
144+
145+
### ๐Ÿ“„ ๋งˆ์ดํŽ˜์ด์ง€
146+
147+
![๋งˆ์ดํŽ˜์ด์ง€ ์ด๋ฏธ์ง€](https://github.com/user-attachments/assets/26b35cb6-2415-4ff6-9b7d-7c7431ff268d)
148+
149+
<br />
150+
151+
## 5๏ธโƒฃ ํ‚ค๋ง ๊ฐœ๋ฐœํŒ€
152+
153+
| ํ”„๋ก ํŠธ์—”๋“œ | ํ”„๋ก ํŠธ์—”๋“œ | ํ”„๋ก ํŠธ์—”๋“œ | ๋ฐฑ์—”๋“œ |
154+
| :--------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------: |
155+
| <img src="https://pub-cf3b9667253a490495a16433a99bd7ca.r2.dev/main-profile-img/%ED%94%84%EB%A1%A0%ED%8A%B8/%EC%96%91%EB%8B%A4%EC%9C%97.png" width="150" /> | <img src="https://pub-cf3b9667253a490495a16433a99bd7ca.r2.dev/main-profile-img/%ED%94%84%EB%A1%A0%ED%8A%B8/%EA%B9%80%ED%95%9C%EC%86%94.png" width="150" /> | <img src="https://pub-cf3b9667253a490495a16433a99bd7ca.r2.dev/main-profile-img/%ED%94%84%EB%A1%A0%ED%8A%B8/%EB%B0%B1%ED%98%9C%EC%9D%B8.png" width="150" /> | <img src="https://pub-cf3b9667253a490495a16433a99bd7ca.r2.dev/main-profile-img/%EB%B0%B1%EC%97%94%EB%93%9C/%EA%B9%80%ED%83%9C%EB%AF%BC.png" width="150" /> |
156+
| [์–‘๋‹ค์œ—](https://github.com/kitworks-kiring/kiring-frontend/pulls?q=is%3Apr+assignee%3Aydw1996+is%3Aclosed) | [๊น€ํ•œ์†”](https://github.com/kitworks-kiring/kiring-frontend/pulls?q=is%3Apr+is%3Aclosed+assignee%3Ahansololiviakim) | [๋ฐฑํ˜œ์ธ](https://github.com/kitworks-kiring/kiring-frontend/pulls?q=is%3Apr+is%3Aclosed+assignee%3Ahyein0112) | [๊น€ํƒœ๋ฏผ](https://github.com/kitworks-kiring/kiring-backend) |

0 commit comments

Comments
ย (0)