Skip to content

Commit b876ed7

Browse files
leejin-rholeejin-rho
authored
Merge pull request #98 from Duri-Salon/docs/readme
[docs] Docs/readme 수정
2 parents 7228bbc + 3ac73c4 commit b876ed7

File tree

1 file changed

+112
-53
lines changed

1 file changed

+112
-53
lines changed

‎README.md

+112-53
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,118 @@
1-
<div align="center">
1+
# 두리묭실(Doori-Salon)
22

3-
# Duri-Salon
3+
<br/>
4+
5+
<img height="150" alt="logo2" src="https://github.com/user-attachments/assets/dc02fab4-f23e-46b7-93c4-fe471f4aba60" />
6+
<img height="150" alt="logo1" style="margin-right: 20px;" src="https://github.com/user-attachments/assets/f470c3c6-84bc-41cd-80a8-02b8da60cb30" />
7+
8+
### 반려견 케어와 미용사의 가치를 함께 완성하는 새로운 반려견 미용 중계 서비스, 두리묭실
9+
</div>
10+
<br/>
411

12+
(현재는 서버 중지하였습니다.)
13+
| Service | URL |
14+
| -------------- | ----------------------------- |
15+
| 고객 서비스 | https://www.duri-salon.store, https://duri-saloncom.vercel.app |
16+
| 미용사 서비스 | https://salon-duri-salon.vercel.app |
17+
| 관리자 서비스 | https://adminduri-saloncom.vercel.app |
18+
19+
20+
#### Demo Video
21+
<div>
22+
<a href="https://www.youtube.com/watch?v=75HMZXuKFms"><img src="https://img.shields.io/badge/YOUTUBE-FF0000?style=for-the-badge&logo=YouTube&logoColor=white&link=https://www.youtube.com/watch?v=oD8ShZGQrqo"/></a>
523
</div>
24+
</br></br>
25+
26+
## 두리묭실 UI
27+
28+
### Design System
29+
[두리묭실 Storybook 링크](https://storybook-durisalon.vercel.app/?path=/docs)
30+
<br/>
31+
32+
<img width="648" alt="storybook screenshot" src="https://github.com/user-attachments/assets/45f3eaee-36a2-4eff-a6dd-c8813da81322" />
33+
34+
### Service UI
35+
<img width="448" src="https://github.com/user-attachments/assets/2721ba03-1cb3-4ce6-a99a-ebe993f07356" />
36+
37+
<br/>
38+
<br/>
39+
40+
**미용 예약 스케줄 관리**
41+
42+
<img height="240" alt="미용 예약 스케줄 관리" src="https://github.com/user-attachments/assets/15fef83a-1288-4a6f-9c8e-fe4e1511f473" />
43+
44+
<br/>
45+
<br/>
46+
47+
**고객 미용일기, 미용사 포트폴리오 서비스**
48+
<br/>
649

50+
<img height="240" alt="고객 미용일기, 미용사 포트폴리오 서비스" src="https://github.com/user-attachments/assets/f7897239-d840-4d56-8746-955b7f132438" />
51+
52+
<br/>
753
<br/>
854

9-
## 1. Project Overview (프로젝트 개요)
55+
**견적서 요청, 견적서 전송 서비스**
56+
<br/>
1057

11-
- **프로젝트 이름**: 두리묭실
12-
- **프로젝트 설명**: 반려견 케어와 미용사의 가치를 함께 완성하는 새로운 반려견 미용 중계 서비스
58+
- 고객
59+
60+
<img alt="견적서 요청, 견적서 전송 서비스1" src="https://github.com/user-attachments/assets/8e777ee6-750b-4b21-9780-8d33518373f1" />
1361

1462
<br/>
1563

64+
- 미용사
65+
66+
<img height="320" alt="견적서 요청, 견적서 전송 서비스2" src="https://github.com/user-attachments/assets/db759de4-a0fd-4b30-b2bd-2fb93614c117" />
67+
68+
<br/>
69+
<br/>
1670

17-
## 2. 프로젝트 구조
71+
**AI 미용 서비스**
1872

19-
## 폴더구조
73+
<br/>
74+
75+
<img alt="AI 미용 서비스" src="https://github.com/user-attachments/assets/d80e1109-46ed-4750-9b6e-f017c04d3dc5" />
76+
77+
<br/>
78+
<br/>
79+
80+
**미용사 월 매출 통계 서비스**
81+
<br/>
82+
83+
<img height="240" alt="미용사 월 매출 통계 서비스" src="https://github.com/user-attachments/assets/e2bafcc2-2f1d-45ba-954c-e7fe38cf3bcd" />
84+
85+
<br/>
86+
<br/>
87+
88+
**맞는 가게 추천을 위한 상세한 온보딩**
89+
<br/>
90+
91+
- 고객
92+
<img alt="상세한 온보딩1" src="https://github.com/user-attachments/assets/57aef78c-ea56-42d5-812e-0714d549f9a7" />
93+
94+
<br/>
95+
96+
- 미용사
97+
<img height="320" alt="상세한 온보딩2" src="https://github.com/user-attachments/assets/342ed345-cc68-4041-9b23-dc7fb81c64d4" />
98+
99+
<br/>
100+
<br/>
101+
102+
**입점 요청, 수락**
103+
<br/>
104+
105+
<img height="240" alt="입점 요청, 수락" src="https://github.com/user-attachments/assets/350ee85c-44bf-4e23-86a3-a7d10402cb96" />
106+
107+
108+
<br/>
109+
<br/>
110+
111+
112+
## 폴더 구조
113+
114+
<details>
115+
<summary> 두리묭실 폴더 구조 </summary>
20116
<br/>
21117

22118
```root/
@@ -114,13 +210,13 @@
114210
115211
116212
```
213+
</details>
117214
<br />
118215

119216

120-
## 3. Technology Stack (기술 스택)
217+
## Technology Stack (기술 스택)
121218
<img width="500" alt="architecture" src="https://github.com/user-attachments/assets/cf16f43b-2c78-446e-8799-13a95f91fae3">
122-
123-
### 3.1 Frontend
219+
<br/>
124220
<table>
125221
<tr>
126222
<th>React</th><th>TypeScript</th><th>React-Query</th>
@@ -132,21 +228,6 @@
132228
</tr>
133229
</table>
134230

135-
### 3.2 Backend
136-
<table>
137-
<tr>
138-
<th>JAVA</th><th>Spring Boot</th><th>OAuth2</th><th>Spring Security</th><th>JWT</th>
139-
</tr>
140-
<tr>
141-
<td align="center"><img src="https://github.com/user-attachments/assets/5df80afe-5c3d-47c1-9f6d-1549d1b2fc42" alt="JAVA" width="100"></td>
142-
<td align="center"><img src="https://github.com/user-attachments/assets/4d0c279a-0dfe-4253-b79e-c615935f9aff" alt="Spring Boot" width="100"></td>
143-
<td align="center"><img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSer4Aw39i08dpwLOdRu_KtK6UOvMDw6Q1Qxw&s" alt="OAuth2" width="100"></td>
144-
<td align="center"><img src="https://github.com/user-attachments/assets/f4744195-f1d0-44d9-b64c-0a027aaaf05a" alt="Spring Security" width="100"></td>
145-
<td align="center"><img src="https://github.com/user-attachments/assets/d43d4e63-3d5c-4ba2-a323-a68c6a8924e1" alt="JWT" width="50"></td>
146-
</tr>
147-
</table>
148-
149-
### 3.3 Cooperation
150231
<table>
151232
<tr>
152233
<th>Git</th><th>Figma</th><th>Notion</th><th>Jira</th>
@@ -161,7 +242,7 @@
161242

162243
<br/>
163244

164-
## 4. 실행 방법
245+
## 실행 방법
165246

166247
```
167248
# 레포지토리를 클론 + 폴더 이동
@@ -170,7 +251,7 @@ git clone https://github.com/Duri-Salon/Duri-FE.git && cd Duri-FE
170251
# 의존성 설치 (yarn-berry 이용)
171252
yarn install
172253
173-
# 개발 서버를 실행 (http://localhost:3000.)
254+
# 개발 서버를 실행 (http://localhost:3000, http://localhost:3001, http://localhost:3002)
174255
yarn dev
175256
176257
# 프로덕션 빌드 파일을 생성 (dist 폴더에 저장됨.)
@@ -182,16 +263,16 @@ yarn preview
182263
<br />
183264

184265

185-
## 5. 팀 규칙
266+
## 팀 규칙
186267

187-
### **5.1 커뮤니케이션 규칙**
268+
### **커뮤니케이션 규칙**
188269
- 매일 **오전 9시** 데일리 스크럼 진행
189270
- **어제 한 일**, **오늘 할 일**, **문제점**을 공유하며 진행 상황 점검.
190271
- 문서 공유 및 회의 기록은 **Notion**을 통해 관리.
191272
- 매주 **일요일 저녁 10시** 정기 회의 진행
192273
- 주간 작업 점검 및 다음 주 계획 수립.
193274

194-
### **5.2 컨벤션**
275+
### 개발 컨벤션**
195276

196277
#### **코딩 컨벤션**
197278
- **프론트엔드 코딩 컨벤션**: [노션링크](https://checkered-muscari-213.notion.site/f526ae57696c49ddbdfc67662d7971d4?pvs=4)
@@ -204,31 +285,9 @@ yarn preview
204285
- **Pull Request 컨벤션**: [노션링크](https://checkered-muscari-213.notion.site/PR-1dbbb6a28d2d4784964e4e855629656c?pvs=4)
205286

206287

207-
### **5.3 Jira로 작업 방식**
288+
### **Jira로 작업 방식**
208289
- Epic, Story, Task 등 우선순위와 작업 단계를 명확히 구분.
209290
- 작업 상태는 **To Do → In Progress → Done**으로 관리.
210291
- 각 Task 완료 시, 관련 **Pull Request 링크**를 Jira에 첨부.
211292

212293
<br/>
213-
214-
215-
216-
## 6. Team Members (팀원 및 팀 소개)
217-
### 6.1 팀명
218-
- **구름잉**
219-
- 애견 미용을 뜻하는 Grooming에서 영감을 받은 이름으로, 구름처럼 포근하고 믿음직한 서비스를 제공하겠다는 목표를 담음.
220-
221-
### 6.2 팀원
222-
| 노이진 | 김찬별 | 심승보 | 윤준수 |
223-
|:----------------------------------------:|:---------------------------------------:|:----------------------------------------:|:----------------------------------------:|
224-
| <img src="https://avatars.githubusercontent.com/u/52371699?v=4" alt="노이진" width="100"> | <img src="https://avatars.githubusercontent.com/u/47071366?v=4" alt="김찬별" width="100"> | <img src="https://avatars.githubusercontent.com/u/112371013?v=4" alt="심승보" width="100"> | <img src="https://avatars.githubusercontent.com/u/174159935?v=4" alt="윤준수" width="100"> |
225-
| FrontEnd | FrontEnd | FrontEnd | FrontEnd |
226-
| [GitHub](https://github.com/leejin-rho) | [GitHub](https://github.com/cksquf98) | [GitHub](https://github.com/seungboshim) | [GitHub](https://github.com/jueunseuk) |
227-
228-
| 김은수 | 김재승 | 김태연 |
229-
|:---------------------------------------:|:----------------------------------:|:----------------------------------------------------:|
230-
| <img src="https://avatars.githubusercontent.com/u/159528848?v=4" alt="김은수" width="100"> | <img src="https://avatars.githubusercontent.com/u/117148033?v=4" alt="김재승" width="100"> | <img src="https://avatars.githubusercontent.com/u/65546884?v=4" alt="김태연" width="100"> |
231-
| BackEnd | BackEnd | BackEnd |
232-
| [GitHub](https://github.com/delight-es) | [GitHub](https://github.com/rlawotmd) | [GitHub](https://github.com/taeyeon0319) |
233-
234-
<br/>

0 commit comments

Comments
 (0)