Skip to content

Commit dcfb516

Browse files
authored
docs: 리드미 업데이트
Updated README to enhance project details and structure.
1 parent 5335239 commit dcfb516

File tree

1 file changed

+81
-31
lines changed

1 file changed

+81
-31
lines changed

README.md

Lines changed: 81 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
# 🍷 WHYNE
2+
<div><img width="1800" height="600" alt="image" src="https://github.com/user-attachments/assets/cd2abace-5bfc-4243-ad41-b7944bbd4f45" /></div>
23

3-
### WHYNE은 사용자가 다양한 와인 리뷰를 확인하고, 구매 여부를 쉽게 판단할 수 있는 와인 리뷰 플랫폼입니다.
44

5-
<img width="1800" height="600" alt="image" src="https://github.com/user-attachments/assets/cd2abace-5bfc-4243-ad41-b7944bbd4f45" />
5+
<br>
6+
7+
## 📖 프로젝트 소개
8+
> WHYNE은 사용자가 다양한 와인 리뷰를 확인하고, 구매 여부를 쉽게 판단할 수 있는 와인 리뷰 플랫폼입니다.
9+
610

711
<br>
812

913
## 🎯 목표
1014

11-
> #### 주어진 요구사항을 충족하는 것을 넘어, 경쟁력 있는 특별한 UI / UX를 도입하고, 사용자에게 최적의 와인 선택 경험을 제공하는 것
15+
> 주어진 요구사항을 충족하는 것을 넘어, 경쟁력 있는 특별한 UI / UX를 도입하고, 사용자에게 최적의 와인 선택 경험을 제공하는 것
1216
1317
<br>
1418

@@ -30,14 +34,7 @@
3034

3135
<br>
3236

33-
## ⏰ Core Time
34-
35-
<span align="right">
36-
37-
🔗 [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki)
38-
39-
</span>
40-
37+
## 📌 데일리 팀 스크럼
4138
> 원활한 소통을 위해 매일 진행하며, 의미 없는 시간이 되지 않도록 **노션 문서화**로 기록합니다.
4239
4340
#### 🗓️ 시간표
@@ -49,41 +46,85 @@
4946

5047
<br>
5148

52-
## Branch 전략
49+
## ⏰ Core Time
50+
> 실시간 이슈 공유를 위해 ZEP 플랫폼을 활용한 온라인 모각코 진행
51+
52+
#### 🕘 시간
53+
매일 09:00 ~ 18:00
54+
55+
<br>
56+
57+
## ⛓️ Branch 전략
58+
59+
60+
<span align="right">
61+
62+
🔗 [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki/%EB%B8%8C%EB%9E%9C%EC%B9%98-%EC%BB%A8%EB%B2%A4%EC%85%98)
63+
64+
</span>
5365

5466
- `main` → 배포
5567
- `develop` → 통합 브랜치
5668
- `feature/*`, `design/*`, `chore/*` → 작업 브랜치 → PR → develop → main
5769

58-
> [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki/%EB%B8%8C%EB%9E%9C%EC%B9%98-%EC%BB%A8%EB%B2%A4%EC%85%98)
70+
<br>
5971

60-
## 기술 스택
72+
## 🧩 기술 스택
6173

62-
- Next.js, React, TypeScript
63-
- Tailwind CSS
64-
- Storybook
65-
- husky + lint-staged
66-
- Vercel (배포)
74+
<span align="right">
75+
76+
🔗 [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki/%EA%B8%B0%EC%88%A0-%EC%8A%A4%ED%83%9D)
6777

68-
> [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki/%EA%B8%B0%EC%88%A0-%EC%8A%A4%ED%83%9D)
78+
</span>
6979

70-
## 깃허브 액션
80+
81+
| 구분 | 사용 기술 | 비고 |
82+
|------|------------|------|
83+
| **Framework** | Next.js (v15), React (v19) | 메인 프레임워크, App Router 기반 |
84+
| **Language** | TypeScript (v5) | 정적 타입 시스템 |
85+
| **Styling** | Tailwind CSS, tailwind-merge | 반응형 및 유틸리티 클래스 관리 |
86+
| **Server State / Data Fetching** | React Query (TanStack v5), Axios | 서버 데이터 캐싱 및 API 통신 |
87+
| **Form Handling** | React Hook Form | 입력값 검증 및 폼 상태 관리 |
88+
| **UI / Animation** | GSAP, Swiper, React Toastify, React Loading Skeleton | 인터랙션, 캐러셀, 알림, 로딩 처리 |
89+
| **Chat UI** | Chat UI Kit (chatscope) | 챗봇 인터페이스 구성 |
90+
| **Utility** | Lodash, clsx, class-variance-authority | 유틸 함수 및 클래스 병합 |
91+
| **Authentication / Cookie** | cookies-next | 로그인 상태 및 쿠키 관리 |
92+
| **Build / Deploy** | Vercel | 정적 배포 및 CI/CD 환경 |
93+
| **Design System / Docs** | Storybook, Chromatic | 컴포넌트 문서화 및 시각 테스트 |
94+
| **Quality / Linting** | ESLint, Prettier, Husky, lint-staged | 코드 품질 및 커밋 훅 관리 |
95+
| **Collaboration** | GitHub, Notion, Figma, Discoard, Zep | 버전 관리 및 협업 툴 |
96+
97+
<br>
98+
99+
## 🤖 깃허브 액션
100+
101+
<span align="right">
102+
103+
🔗 [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki/%EA%B9%83%ED%97%88%EB%B8%8C-%EC%95%A1%EC%85%98)
104+
105+
</span>
71106

72107
- Vercel 배포
73108
- Chromatic으로 Storybook 배포 (develop 기준)
74109

75-
> [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki/%EA%B9%83%ED%97%88%EB%B8%8C-%EC%95%A1%EC%85%98)
110+
<br>
111+
112+
## 🗒️ 프로젝트 관리
76113

77-
## 프로젝트 관리
114+
<span align="right">
115+
116+
🔗 [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki/%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EA%B4%80%EB%A6%AC)
117+
118+
</span>
78119

79120
- README: 프로젝트 개요 / 기술 스택 / 실행 방법
80121
- Wiki: 세부 규칙, 가이드 문서, 브랜치 룰
81122
- Notion: 회의록, 멘토링 피드백, 참고 자료
82123
- GitHub Project: 일정 / TODO 관리
83124

84-
> [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki/%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EA%B4%80%EB%A6%AC)
125+
<br>
85126

86-
## 실행 방법
127+
## ⚙️ 실행 방법
87128

88129
```bash
89130
# 패키지 설치
@@ -99,7 +140,15 @@ npm run storybook
99140
NEXT_PUBLIC_API_URL=http://localhost:4000
100141
```
101142

102-
## 폴더 구조
143+
<br>
144+
145+
## 📂 폴더 구조
146+
147+
<span align="right">
148+
149+
🔗 [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki/%ED%8F%B4%EB%8D%94-%EA%B5%AC%EC%A1%B0)
150+
151+
</span>
103152

104153
```bash
105154
src
@@ -114,10 +163,11 @@ src
114163
┗ utils # 공통 유틸리티 함수
115164
```
116165

117-
> [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki/%ED%8F%B4%EB%8D%94-%EA%B5%AC%EC%A1%B0)
166+
<br>
167+
168+
## 🔎 바로가기
118169

119-
## 바로가기
120170

121-
- [배포 바로가기](https://wine-phi-olive.vercel.app/)
122-
- [스토리북 바로가기](https://68d3998e0b054d1207706cbb-rwsgeadjmd.chromatic.com/?path=/story/%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EC%84%B8%ED%8C%85-%ED%8F%B0%ED%8A%B8-%EC%BB%AC%EB%9F%AC--font-color)
123-
- [Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki)
171+
- [🚀 배포 바로가기](https://wine-phi-olive.vercel.app/)
172+
- [스토리북 바로가기](https://68d3998e0b054d1207706cbb-rwsgeadjmd.chromatic.com/?path=/story/%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EC%84%B8%ED%8C%85-%ED%8F%B0%ED%8A%B8-%EC%BB%AC%EB%9F%AC--font-color)
173+
- [📖 Wiki 바로가기](https://github.com/Team-3-2/Wine/wiki)

0 commit comments

Comments
 (0)