Skip to content

Commit bac063c

Browse files
add ReadME
1 parent 5209739 commit bac063c

File tree

1 file changed

+53
-123
lines changed

1 file changed

+53
-123
lines changed

README.md

Lines changed: 53 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -1,159 +1,89 @@
1-
# 23-5-team9-server
2-
### 와플스튜디오 23.5기 9조 server Workflow
1+
## Team 9
32

4-
Change IP
3+
### Frontend
54

6-
- 기본 작업 브랜치: `dev`
7-
- 각 기능들을 개발할 때: `feature/function` 브랜치를 만들어 해당 브랜치에서 작업
8-
- 기능이 완성된 경우 `dev` 브랜치로 병합 후 디버깅
9-
- 디비깅이 완료되면 `main` 브랜치로 병합
5+
* 설한동, 정현수
106

11-
---
7+
### Backend
128

13-
# 기능 매핑 및 구현 범위
9+
* 부민성, 장우혁, 송민혁
1410

15-
## 1. 인증 / 회원 관리
1611

17-
### 회원가입
18-
- 이메일 / 비밀번호 기반 회원가입
19-
- 비밀번호 해싱 처리
20-
- 이메일 중복 검사
21-
- 입력값 유효성 검증
12+
---
2213

23-
### 로그인 / 로그아웃
24-
- 이메일 + 비밀번호 로그인
25-
- 인증 토큰 발급 (Access / Refresh)
26-
- 로그아웃 시 토큰 무효화
14+
## About The Project
2715

28-
### 소셜 로그인
29-
- OAuth2 기반 소셜 로그인 (예: Google, Kakao)
30-
- 최초 로그인 시 회원 자동 생성
31-
- 기존 계정과의 연동 정책 정의
16+
본 레포지토리는 **와플스튜디오 23.5기 9조**의 중고거래/경매 프로젝트입니다.
17+
**빈티지 물품을 경매로 사고 팔 수 있는 중고거래 사이트**를 목표로 하며, 기본적인 중고 거래 기능에 더해 실시간 채팅과 경매 시스템을 제공합니다.
3218

3319
---
3420

35-
## 2. 게시물 (중고 거래)
36-
37-
### 게시물 관리
38-
- 게시물 생성 / 조회 / 수정 / 삭제 (CRUD)
39-
- 작성자 권한 검증
40-
- 게시물 상태 관리
41-
- 판매중 / 거래완료
42-
43-
### 게시물 정보
44-
- 제목, 내용, 가격
45-
- 카테고리
46-
- 지역 정보
47-
- 이미지 다중 첨부
48-
→ 이미지 업로드 기능을 활용
21+
## Tech Stack
4922

50-
### 목록 조회
51-
- 최신순 / 가격순 정렬
52-
- 카테고리 필터
53-
- 지역 기반 필터
54-
- 페이지네이션 적용
55-
**중고 거래(게시물) 페이지네이션**
23+
* **Backend**: FastAPI
24+
* **Database**: MySQL
25+
* **Storage**: AWS S3
26+
* **Infra**: Docker, Nginx
27+
* **CI/CD**: GitHub Actions
5628

5729
---
5830

59-
## 3. 지역 선택
31+
## Workflow
6032

61-
### 지역 설정
62-
- 유저 기본 지역 설정
63-
- 지역 변경 기능
64-
65-
### 지역 기반 노출
66-
- 게시물 조회 시 지역 필터 적용
67-
- 내 지역 중심 피드 구성
33+
* 기본 작업 브랜치: `dev`
34+
* 기능 개발: `feature/<function>` 브랜치
35+
* 기능 완료 후 `dev` 병합 및 디버깅
36+
* 안정화 후 `main` 브랜치 병합
6837

6938
---
7039

71-
## 4. 좋아요 / 즐겨찾기
40+
## Features
7241

73-
### 좋아요 기능
74-
- 게시물 좋아요 등록 / 취소
75-
- 중복 좋아요 방지
42+
### 1. 인증 / 회원 관리
7643

77-
### 관심 목록
78-
- 내가 좋아요한 게시물 목록 조회
79-
- 페이지네이션 적용
80-
**프로필 페이지네이션**
44+
* 이메일 기반 회원가입 / 로그인
45+
* 비밀번호 해싱 및 중복 검사
46+
* JWT 인증 (Access / Refresh)
47+
* OAuth2 소셜 로그인 (확장)
8148

82-
---
49+
### 2. 게시물 (중고 거래)
8350

84-
## 5. 중고 거래 + 가상 화폐 결제
51+
* 게시물 CRUD
52+
* 카테고리 / 지역 기반 필터링
53+
* 이미지 다중 업로드
54+
* 페이지네이션 지원
8555

86-
### 가상 화폐(포인트)
87-
- 사용자 지갑 관리
88-
- 잔액 조회
89-
- 포인트 충전 (테스트용)
56+
### 3. 지역 설정
9057

91-
### 거래 프로세스
92-
- 구매 요청 → 판매자 수락 → 결제 → 거래 완료
93-
- 거래 상태 관리
94-
- `REQUESTED / ACCEPTED / PAID / COMPLETED / CANCELED`
58+
* 사용자 기본 지역 설정
59+
* 지역 기반 게시물 노출
9560

96-
### 정합성 처리
97-
- 잔액 부족 검증
98-
- 중복 결제 방지
99-
- 트랜잭션 처리
61+
### 4. 좋아요 / 관심 목록
10062

101-
### 거래 내역 조회
102-
- 구매 / 판매 내역 조회
103-
- 페이지네이션 적용
104-
**프로필 페이지네이션**
63+
* 게시물 좋아요 등록 / 취소
64+
* 관심 게시물 목록 조회
10565

106-
---
66+
### 5. 가상 화폐 거래
10767

108-
## 6. 채팅
68+
* 포인트 지갑 관리
69+
* 거래 상태 관리
70+
* 트랜잭션 기반 정합성 처리
10971

110-
### 채팅 유형
111-
- 게시물 기반 1:1 채팅
72+
### 6. 채팅
11273

113-
### 기능
114-
- 채팅방 생성
115-
- 메시지 전송 / 조회
116-
- 채팅방 목록 조회
74+
* 게시물 기반 1:1 채팅
75+
* WebSocket 실시간 메시지
76+
* 채팅방 / 메시지 페이지네이션
11777

118-
### 실시간 통신
119-
- WebSocket 기반 실시간 메시지 처리
120-
- (선택) 읽음 상태 처리
78+
### 7. 경매 (추가 기능)
12179

122-
### 목록 조회
123-
- 채팅방 목록 페이지네이션
124-
- 메시지 히스토리 페이지네이션
125-
**채팅 페이지네이션**
80+
* 경매 게시물 관리
81+
* 입찰 시스템 및 동시성 제어
82+
* 낙찰 및 자동 결제 처리
12683

12784
---
12885

129-
## 7. 경매 (추가 기능)
130-
131-
### 경매 게시물
132-
- 경매 전용 게시물 생성
133-
- 시작가 / 즉시구매가 / 최소입찰단위
134-
- 경매 시작 / 종료 시간
135-
- 경매 상태 관리
136-
- `SCHEDULED / LIVE / ENDED / CANCELED`
137-
- 이미지 첨부
138-
→ 이미지 업로드 기능 활용
139-
140-
### 경매 목록
141-
- 경매 게시물 목록 조회
142-
- 페이지네이션 적용
143-
**경매 페이지네이션**
144-
145-
### 그룹 채팅
146-
- 경매 참가자 전용 그룹 채팅방
147-
- 참가 버튼을 통한 입장
148-
- 시스템 메시지(입찰 갱신, 마감 안내 등)
149-
150-
### 입찰 시스템
151-
- 입찰 금액 검증
152-
- 최소 입찰 단위 검증
153-
- 마감 이후 입찰 차단
154-
- 동시성 제어를 통한 최고가 보장
155-
156-
### 낙찰 및 결제
157-
- 경매 종료 시 자동 낙찰 처리
158-
- 낙찰자 가상 화폐 결제
159-
- 거래 기록 생성
86+
## Contributing
87+
88+
* 기능 단위로 브랜치 생성
89+
* PR 시 기능 설명 및 테스트 내용 명시

0 commit comments

Comments
 (0)