diff --git a/README.md b/README.md index dca7842..c1b34f7 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,118 @@ -
+# 두리묭실(Doori-Salon) -# Duri-Salon +
+ +logo2 +logo1 + +### 반려견 케어와 미용사의 가치를 함께 완성하는 새로운 반려견 미용 중계 서비스, 두리묭실 +
+
+(현재는 서버 중지하였습니다.) +| Service | URL | +| -------------- | ----------------------------- | +| 고객 서비스 | https://www.duri-salon.store, https://duri-saloncom.vercel.app | +| 미용사 서비스 | https://salon-duri-salon.vercel.app | +| 관리자 서비스 | https://adminduri-saloncom.vercel.app | + + +#### Demo Video +
+
+

+ +## 두리묭실 UI + +### Design System +[두리묭실 Storybook 링크](https://storybook-durisalon.vercel.app/?path=/docs) +
+ +storybook screenshot + +### Service UI + + +
+
+ +**미용 예약 스케줄 관리** + +미용 예약 스케줄 관리 + +
+
+ +**고객 미용일기, 미용사 포트폴리오 서비스** +
+고객 미용일기, 미용사 포트폴리오 서비스 + +

-## 1. Project Overview (프로젝트 개요) +**견적서 요청, 견적서 전송 서비스** +
-- **프로젝트 이름**: 두리묭실 -- **프로젝트 설명**: 반려견 케어와 미용사의 가치를 함께 완성하는 새로운 반려견 미용 중계 서비스 +- 고객 + +견적서 요청, 견적서 전송 서비스1
+- 미용사 + +견적서 요청, 견적서 전송 서비스2 + +
+
-## 2. 프로젝트 구조 +**AI 미용 서비스** -## 폴더구조 +
+ +AI 미용 서비스 + +
+
+ +**미용사 월 매출 통계 서비스** +
+ +미용사 월 매출 통계 서비스 + +
+
+ +**맞는 가게 추천을 위한 상세한 온보딩** +
+ +- 고객 +상세한 온보딩1 + +
+ +- 미용사 +상세한 온보딩2 + +
+
+ +**입점 요청, 수락** +
+ +입점 요청, 수락 + + +
+
+ + +## 폴더 구조 + +
+ 두리묭실 폴더 구조
```root/ @@ -114,13 +210,13 @@ ``` +

-## 3. Technology Stack (기술 스택) +## Technology Stack (기술 스택) architecture - -### 3.1 Frontend +
@@ -132,21 +228,6 @@
ReactTypeScriptReact-Query
-### 3.2 Backend - - - - - - - - - - - -
JAVASpring BootOAuth2Spring SecurityJWT
JAVASpring BootOAuth2Spring SecurityJWT
- -### 3.3 Cooperation @@ -161,7 +242,7 @@
-## 4. 실행 방법 +## 실행 방법 ``` # 레포지토리를 클론 + 폴더 이동 @@ -170,7 +251,7 @@ git clone https://github.com/Duri-Salon/Duri-FE.git && cd Duri-FE # 의존성 설치 (yarn-berry 이용) yarn install -# 개발 서버를 실행 (http://localhost:3000.) +# 개발 서버를 실행 (http://localhost:3000, http://localhost:3001, http://localhost:3002) yarn dev # 프로덕션 빌드 파일을 생성 (dist 폴더에 저장됨.) @@ -182,16 +263,16 @@ yarn preview
-## 5. 팀 규칙 +## 팀 규칙 -### **5.1 커뮤니케이션 규칙** +### **커뮤니케이션 규칙** - 매일 **오전 9시** 데일리 스크럼 진행 - **어제 한 일**, **오늘 할 일**, **문제점**을 공유하며 진행 상황 점검. - 문서 공유 및 회의 기록은 **Notion**을 통해 관리. - 매주 **일요일 저녁 10시** 정기 회의 진행 - 주간 작업 점검 및 다음 주 계획 수립. -### **5.2 컨벤션** +### 개발 컨벤션** #### **코딩 컨벤션** - **프론트엔드 코딩 컨벤션**: [노션링크](https://checkered-muscari-213.notion.site/f526ae57696c49ddbdfc67662d7971d4?pvs=4) @@ -204,31 +285,9 @@ yarn preview - **Pull Request 컨벤션**: [노션링크](https://checkered-muscari-213.notion.site/PR-1dbbb6a28d2d4784964e4e855629656c?pvs=4) -### **5.3 Jira로 작업 방식** +### **Jira로 작업 방식** - Epic, Story, Task 등 우선순위와 작업 단계를 명확히 구분. - 작업 상태는 **To Do → In Progress → Done**으로 관리. - 각 Task 완료 시, 관련 **Pull Request 링크**를 Jira에 첨부.
- - - -## 6. Team Members (팀원 및 팀 소개) -### 6.1 팀명 -- **구름잉** -- 애견 미용을 뜻하는 Grooming에서 영감을 받은 이름으로, 구름처럼 포근하고 믿음직한 서비스를 제공하겠다는 목표를 담음. - -### 6.2 팀원 -| 노이진 | 김찬별 | 심승보 | 윤준수 | -|:----------------------------------------:|:---------------------------------------:|:----------------------------------------:|:----------------------------------------:| -| 노이진 | 김찬별 | 심승보 | 윤준수 | -| FrontEnd | FrontEnd | FrontEnd | FrontEnd | -| [GitHub](https://github.com/leejin-rho) | [GitHub](https://github.com/cksquf98) | [GitHub](https://github.com/seungboshim) | [GitHub](https://github.com/jueunseuk) | - -| 김은수 | 김재승 | 김태연 | -|:---------------------------------------:|:----------------------------------:|:----------------------------------------------------:| -| 김은수 | 김재승 | 김태연 | -| BackEnd | BackEnd | BackEnd | -| [GitHub](https://github.com/delight-es) | [GitHub](https://github.com/rlawotmd) | [GitHub](https://github.com/taeyeon0319) | - -
GitFigmaNotionJira