README.md

쉽고 합리적 거래를 위한 개인경매 서비스, BID

SSAFY 공통 PJT TEAM 928

목차

1. 웹 서비스 소개
2. 기술 스택
3. 주요 기능
4. 프로젝트 구성도
5. 서비스 화면
6. 개발 팀 소개
7. 개발 기간 및 일정
8. 협업 컨벤션
9. 디렉터리 구조
10. 산출물

✨ 웹 서비스 소개

BID는 개인간 물품을 라이브 경매를 통해 합리적인 가격으로 쉽고, 빠르게 거래할 수 있는 서비스입니다.
BID를 사용하여 실시간 라이브를 통해 희망 거래 물건의 현재 상태를 미리 확인할 수 있습니다.
또한 경매 및 역경매를 통해 판매자와 구매자 모두 합리적인 가격에 거래 가능합니다.

BID 바로 가기

🛠️ 기술 스택

Frontend

HTML5	CSS3	React	Typescript	Tailwind CSS

React Query	Openvidu	Stomp js	Axios	Zustand

Eslint	Prettier	Vite

Backend

Java	Spring	Hibernate	Mariadb	MongoDB

Redis	Swagger	Jasypt	Spring security	Openvidu

Stomp js

DevOps

AWS	Docker	Nginx	Jenkins

Tools

Notion	Gitlab	Jira	Gerrit	Mattermost

💡 주요 기능

기능	내용
실시간 라이브 방송	경매와 역경매 글을 작성하고, 예정된 라이브 시간이 되면 실시간 라이브 서비스를 통해 자신의 물건을 판매, 구매 할 수 있습니다. 라이브 방송 중 채팅 또한 가능합니다.
실시간 1:1 채팅	즉시 구매나 낙찰을 통해 거래가 확정되면 1:1 채팅방이 생성되고 1:1 채팅을 통해 상대방과 대화할 수 있습니다.
알림 서비스	관심있는 거래를 등록하고, 해당 거래의 라이브 방송 전 알림을 받을 수 있습니다. 또한 낙찰 및 상위입찰 발생 시에도 알림을 받을 수 있습니다.
소셜 로그인	사용자는 네이버, 카카오 소셜 로그인을 통해 서비스에 가입할 수 있습니다.
결제	IamPort 결제 api를 활용하여 카카오페이 QR코드를 통해 사용자는 모의 포인트 충전을 진행할 수 있습니다.
경매글 조회	실시간 핫 경매, 마감 임박, 진행 예정 경매, 라이브 진행 중인 경매 등 인기 있는 경매들을 메인 화면에서 조회할 수 있습니다.
상세 조회	물건의 상세 정보를 조회할 수 있으며 라이브를 진행한 물품이라면 녹화영상, 타임 스탬프, STT를 적용한 라이브 요약본을 추가적으로 확인할 수 있습니다.
카테고리 별 조회 및 검색	여러 사용자가 작성한 경매 및 역경매 글에 대해 다양한 필터를 제공하여 원하는 물품을 조회 할 수 있습니다. (카테고리별, 지역별, 경매시작전, 경매진행중, 라이브진행중 등)
신뢰도 지표	사용자의 서비스 이용 내역에 따라 신뢰도 지표를 계산하여 거래 과정에서 서로의 신뢰도를 파악할 수 있는 기능을 제공합니다.

📂 프로젝트 구상도

🖥️ 서비스 화면

회원가입	메인페이지	카테고리 및 필터링 기능

검색	알림	위시

경매글 작성	경매글 상세보기

역경매글 작성	역경매글 상세보기

경매 라이브

가이드라인	라이브 방송

역경매 라이브

발언권 신청	매칭하기	매칭 확정하기

라이브 채팅

즉시구매 기능	1:1 채팅 기능	리뷰 작성

프로필 조회	다른 유저 프로필 조회	포인트 내역 조회

👨🏻‍💻 개발 팀 소개

FE	FE	FE	BE	BE	BE
이수화	이승현	최민경	윤희원	차성원	최용수

🗓️ 개발 기간 및 일정

24.01.03. ~ 24.02.16

⚙️ 협업 컨벤션

Commit

type: #[issueNumber] - 커밋 내용 최대 50자
> 띄우기
커밋 설명(이건 선택)

header type

feat: 새로운 기능을 추가
fix: 버그 수정 또는 기능에 대한 큰 변화와 결과에 변화가 있을 때
docs: 문서 관련 커밋
refactor: 기능에 대한 변화 없이 리팩토링
style: 코드 스타일 변경(formatting, missing semi colons, …)
test: 테스트 관련 커밋
chore: 기타 커밋, 환경설정
init: 프로젝트 생성

예제

feat: 로그인 API 구현 #[이슈키] #[상태]

Branch

1. branch 종류

• 서비스 출시 : main
• 개발 : develop
• 기능 개발 : feature

2. feature branch 명

front : feature/[지라 스토리 번호]/fe
back : feature/[지라 스토리 번호]/be

📂 디렉터리 구조

Front-end

📂 src
├─📂 apis
├─📂 assets
│  ├─icon
│  └─image
├─📂 components
├─📂 constants
├─📂 hooks
├─📂 pages
│  ├─chat
│  ├─home
│  ├─live
│  ├─login
│  ├─notify
│  ├─profile
│  ├─review
│  ├─scrap
│  ├─search
│  ├─signup
│  └─write
├─📂 service
├─📂 stores
├─📂 types
│  └─model
│  └─api
└─📂 utils

Back-end

📂 main
├─java
│  └─com
│      └─qzp
│          └─bid
│              ├─domain
│              │  ├─auth
│              │  │  ├─api
│              │  │  ├─controller
│              │  │  ├─dto
│              │  │  └─service
│              │  ├─chat
│              │  │  ├─controller
│              │  │  ├─dto
│              │  │  ├─entity
│              │  │  ├─mapper
│              │  │  ├─repository
│              │  │  └─service
│              │  ├─deal
│              │  │  ├─controller
│              │  │  ├─dto
│              │  │  ├─entity
│              │  │  ├─mapper
│              │  │  ├─purchase
│              │  │  │  ├─controller
│              │  │  │  ├─dto
│              │  │  │  ├─entity
│              │  │  │  ├─mapper
│              │  │  │  ├─repository
│              │  │  │  └─service
│              │  │  ├─repository
│              │  │  ├─sale
│              │  │  │  ├─controller
│              │  │  │  ├─dto
│              │  │  │  ├─entity
│              │  │  │  ├─mapper
│              │  │  │  ├─repository
│              │  │  │  └─service
│              │  │  ├─scheduler
│              │  │  └─service
│              │  ├─live
│              │  │  ├─controller
│              │  │  ├─dto
│              │  │  ├─entity
│              │  │  ├─mapper
│              │  │  ├─repository
│              │  │  └─service
│              │  ├─member
│              │  │  ├─controller
│              │  │  ├─dto
│              │  │  ├─entity
│              │  │  ├─mapper
│              │  │  ├─repository
│              │  │  └─service
│              │  └─sse
│              │      ├─controller
│              │      ├─dto
│              │      ├─repository
│              │      └─service
│              └─global
│                  ├─config
│                  ├─result
│                  │  └─error
│                  │      └─exception
│                  ├─security
│                  │  ├─filter
│                  │  └─util
│                  └─util
└─resources

📃 산출물

1. 기능 명세서

2. 와이어 프레임

3. API 명세서

4. ERD

5. 포팅메뉴얼