Skip to content

Commit 74141c1

Browse files
docs: 버그카운티용 리드미 추가 (#49)
* docs: store, dashboard, review 기능 관련 문서 추가 * docs: menu페이지들의 기능 관련 문서 추가 * docs: common과 주문관련 기능 doc 내용 추가 * docs: 로그인 버그 이슈 추가 * docs: 버그바운티 관련 문서 통합 및 Readme에 링크 연결 --------- Co-authored-by: jangwon <yoonjangwon94@gmail.com>
1 parent 411f35e commit 74141c1

File tree

2 files changed

+115
-2
lines changed

2 files changed

+115
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,27 @@
1212
- 테스트 : StoryBook, Cypress(미정)
1313
- node : node v20.16.0 이상
1414

15-
## 실행
15+
## 실행 방법
16+
17+
### 환경변수
18+
19+
```
20+
VITE_USE_MSW="true" // MSW 사용하는 경우
21+
VITE_API_BASE_URL="/api/v1"
22+
VITE_KAKAO_MAP_KEY=ab8c859d7d2f6ccd51454ffee6559ff4
23+
```
24+
25+
### 실행
1626

1727
```bash
1828
npm install
1929
npm run dev
2030
```
2131

32+
### 버그바운티를 위한 현재까지 진행된 사항에 관련한 문서
33+
34+
- [버그바운티:구현 안내사항](https://github.com/FC-InnerCircle/icd01-team02-o2o2-fe/blob/main/docs/Bug.md)
35+
2236
## 구조
2337

2438
```md
@@ -68,7 +82,7 @@ project-root/
6882
- src
6983

7084
```js
71-
import { counterAtom } from "atoms/sample";
85+
import { counterAtom } from 'atoms/sample';
7286
```
7387

7488
## Rules

docs/Bug.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# 버그 이슈를 위한 안내 사항
2+
3+
## 공통
4+
5+
- 반응형 UI구현은 완료되지 않아서, PC버전으로 진행해주시기 바랍니다.
6+
- API 연동이 완료되지 않은 상황이라, 수정, 추가 등의 기능후 반영이 되지 않을 수 있습니다.
7+
- 현재 가게 사장님 기준으로만 구현이 되었습니다.
8+
- 메뉴에 없는 페이지는 구현되지 않은 기능이라고 생각하셔도 됩니다.
9+
10+
## 메뉴 등록 페이지
11+
12+
### 📚 구현되지 않은 기능
13+
14+
- 현재 API 연동이 완료되지 않아 "등록하기" 버튼을 눌렀을 때, 메뉴가 생성되지 않는 것은 정상입니다!
15+
- "미리보기"버튼 클릭시 화면 UI구현은 아직 완료되지 않았습니다.
16+
- 메뉴 사진 등록시 확장자 Validation은 현재 되지 않습니다(모든 확장자 가능, 빠른 수정예정)
17+
-
18+
19+
### 📝 구현 기능
20+
21+
- 메뉴 사진 파일 등록, 수정
22+
- 각종 Input에 값 넣는 부분, 수정
23+
- 메뉴 옵션과 관련된 추가와, 수정, 삭제
24+
25+
## 메뉴 리스트 보기
26+
27+
### 📚 구현되지 않은 기능
28+
29+
- Pagination
30+
31+
### 📝 구현 기능
32+
33+
- 메뉴 리스트 보기
34+
- 메뉴 클릭시 상세로 이동
35+
36+
## 메뉴 상세
37+
38+
### 📚 구현되지 않은 기능
39+
40+
- 메뉴 등록과 마찬가지로 API 미연동으로 현재 "저장" 버튼을 눌러도 반영되지 않습니다.
41+
- 메뉴 등록과 마찬가지로 "미리기보기"버튼은 기능하지 않습니다.
42+
- 메뉴 삭제
43+
44+
### 📝 구현 기능
45+
46+
- 등록된 메뉴의 기본 정보 수정
47+
- 옵션의 추가, 수정, 삭제 UI
48+
49+
## 주문(Order)
50+
51+
### 📝 구현 기능
52+
53+
- 주문 리스트 보기
54+
- 주문 리스트에 상태별 필터링
55+
- 주문 상세 간략 보기(클릭시)
56+
57+
### 📚 구현되지 않은 기능
58+
59+
- 주문 상태 변경 기능
60+
61+
## 리뷰 페이지
62+
63+
### 📝 구현 기능
64+
65+
- 리스트 뷰 UI 구현
66+
67+
### 📚 구현되지 않은 기능
68+
69+
- API 연동이 되지 않아, MSW로 대체합니다.
70+
- 오름차순, 내림차순 필터 기능
71+
- 인피니트 스크롤 기능
72+
73+
## Store 페이지
74+
75+
### 📝 구현 기능
76+
77+
- 이미지 업로드: @AyoungWon님 pic-pik 외부 라이브러리 연동
78+
- 카카오 MAP API 연동
79+
- 우편 찾기 버튼 시 다음 우편 찾기 모달이 보여아 한다.
80+
- 주소를 클릭시 상세 주소를 제외한 Input(우편주소, 도로명 주소) 필드에 값이 들어가야한다.
81+
- React hooks form 라이브러리 사용을 통한 form 관리
82+
- zod를 사용해서 유효성 처리
83+
84+
### 📚 구현되지 않은 기능
85+
86+
- API 연동이 되지 않아, MSW로 대체합니다.
87+
- 저장 버튼이 API와 연동되어있지 않습니다.
88+
- 현재는 음식점 카테고리를 선택하지 않아도 저장 버튼을 눌렀을 때, 유효성을 체크를 하지 않는게 정상입니다.(추후 보완예정)
89+
90+
## 로그인 페이지
91+
92+
### 📝 구현 기능
93+
94+
- 로그인 이메일 유효성 처리
95+
- 에러 메세지 생성
96+
97+
### 📚 구현되지 않은 기능
98+
99+
- API 연동이 되지 않았습니다.

0 commit comments

Comments
 (0)