-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
📝 docs: 리드미 작성
- Loading branch information
Showing
2 changed files
with
44 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,66 +1,89 @@ | ||
# <Img width="120px" src="https://github.com/minseokiim/minseokiim/assets/55376275/8b07c7d2-e412-4772-9a38-1d6ea20be94f" /> | ||
# <img width="150px" alt="image" src="https://github.com/catchroom/BE_CatchRoom/assets/114489245/94228459-9aef-4069-975d-bee133b5c7c2"> | ||
|
||
(프로젝트 설명?) | ||
<br/> | ||
### 📝 주제 | ||
|
||
### ☘️ 배포 사이트 | ||
https://dev.dhlbrqe2v28e4.amplifyapp.com/home | ||
취소 수수료 발생 숙박매물을 고객간에 거래할 수 있는 중개거래 플랫폼 | ||
<br/> | ||
|
||
### 🌷 배포 사이트 | ||
|
||
### 개발 기간 | ||
2023.12.26 - 2024.01.29 | ||
[![CatchRoom](https://img.shields.io/badge/CatchRoom-F0047F.svg?style=for-the-badge)](https://dev.dhlbrqe2v28e4.amplifyapp.com/home) | ||
|
||
<br/> | ||
|
||
## 🎞️ 시연 영상 | ||
### 🎞️ 시연 영상 | ||
|
||
(링크) | ||
<br/> | ||
|
||
### 🚀 프로젝트 인원 및 기간 | ||
|
||
- **개발 인원**: FE 6명 & BE 4명 | ||
- **프로젝트 기간**: 12월 11일(월) ~ 1월 29일(월) | ||
|
||
<br/> | ||
|
||
## ✨ 팀원 | ||
| <img src="https://avatars.githubusercontent.com/u/107862297?v=4" width="150px" /> | <img src="https://avatars.githubusercontent.com/u/55376275?v=4" width="150px" /> | <img src="https://avatars.githubusercontent.com/u/65649035?v=4" width="150px" /> | <img src="https://avatars.githubusercontent.com/u/92326949?v=4" width="150px" /> | <img src="https://avatars.githubusercontent.com/u/122848687?v=4" width="150px" /> | <img src="https://avatars.githubusercontent.com/u/139189610?v=4" width="150px" /> | | ||
| :-----------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------: |:------------------------------------------------------------------------------------------------------------: | | ||
| **FE_김민섭 (팀장)** | **FE_김민서** | **FE_김지민** | **FE_박수연** | **FE_박준규** | **FE_이승연** | | ||
| 민섭님 | **회원가입 / 로그인** <br /> -회원가입시 유효성 검사<br /> - 이메일/닉네임 중복 체크 <br /> - 토큰 관리 <br /><br /> **마이페이지** <br /> - 유저 정보 조회 및 닉네임 수정<br /> - 계좌 등록/수정/삭제<br /> - 예치금 내역 조회/출금<br /> - 찜 목록 조회 및 찜 삭제<br /> - 구매 목록 조회 및 구매 상세내역 조회<br /> - 판매내역(게시중/게시만료) 조회 및 삭제<br /> - 게시만료 타입에 따라 상태 구분 <br />- 리뷰 등록/수정/삭제/조회 | **판매페이지** <br /> - 판매 가능한 숙박권 조회 <br /> - 판매할 상품 가격 및 종료날짜, 캐치특가 여부 및 종료날짜 및 가격, 판매자한마디 설정 및 등록<br /> 판매한 상품 수정/삭제<br /><br/> **메인 페이지** <br /> - 캐치특가 상품 및 리뷰 조회 <br /><br /> **캐치특가 페이지**<br /> - 캐치특가 상품 조회<br /> -무한 스크롤 기능 <br /> -지역, 드롭다운 필터를 사용한 세분화 조회 <br /><br/> **리뷰 페이지** <br /> - 무한 스크롤 기능<br /><br /> **공동 컴포넌트** <br /> - 모달 구현 | **구매 페이지**<br/> - 상품 정보 조회<br/> - 이용자 정보 등록<br/> - 결제 수단 설정 <br/><br/> **결제 완료 페이지**<br/> - 상품 정보 / 예약 정보 조회 <br/><br/> **검색 결과 페이지**<br/> - 필터링, 무한스크롤 기반 한 상품 리스트 조회 <br/> - 지도에서 상품 위치, 상품 정보 조회<br/><br/> **공동 컴포넌트** <br/> - 상단 app bar / 하단 nav bar 구현 | **상세검색 페이지** <br /> - 지역선택 및 숙소유형 버튼 필터 구현 <br /> - 범위선택 달력 및 인원 수 선택 카운터 구현<br /><br/> **체크인 마감임박(메인 & 페이지)** <br /> - 일주일 조회 및 선택 가능한 달력 구현 <br /> - 지역선택 필터 재사용 및 적용<br /> - 상품 무한 스크롤 구현<br /><br/> **상품 상세페이지** <br /> - 상품 이미지 스와이퍼(캐러셀) 구현<br /> -찜하기 기능 구현<br /><br/> **공동 컴포넌트** <br /> - 버튼 구현 (슬라이드, 체크박스, 찜버튼) <br /> - ToastAlert 구현 및 커스텀 훅 추가 구현<br /> - 상품 공동 컴포넌트 구현<br /> - 단일선택 및 범위선택 달력 구현<br /> - 검색 필터 공동 컴포넌트화 | **채팅** <br /> - 실시간 채팅을 위한 웹소켓 연결 <br /> - 구매자/판매자간 채팅방 생성 기능 구현 <br /> - 채팅 주고 받기 기능 구현 <br /> - 네고하기 및 네고 가격 결제 기능 구현 | | ||
|
||
| <img src="https://avatars.githubusercontent.com/u/107862297?v=4" width="150px" /> | <img src="https://avatars.githubusercontent.com/u/55376275?v=4" width="150px" /> | <img src="https://avatars.githubusercontent.com/u/65649035?v=4" width="150px" /> | <img src="https://avatars.githubusercontent.com/u/92326949?v=4" width="150px" /> | <img src="https://avatars.githubusercontent.com/u/122848687?v=4" width="150px" /> | <img src="https://avatars.githubusercontent.com/u/139189610?v=4" width="150px" /> | | ||
| :-------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | ||
| **FE\_김민섭 (팀장)** | **FE\_김민서** | **FE\_김지민** | **FE\_박수연** | **FE\_박준규** | **FE\_이승연** | | ||
| 민섭님 | **회원가입 / 로그인** <br /> -회원가입시 유효성 검사<br /> - 이메일/닉네임 중복 체크 <br /> - 토큰 관리 <br /><br /> **마이페이지** <br /> - 유저 정보 조회 및 닉네임 수정<br /> - 계좌 등록/수정/삭제<br /> - 예치금 내역 조회/출금<br /> - 찜 목록 조회 및 찜 삭제<br /> - 구매 목록 조회 및 구매 상세내역 조회<br /> - 판매내역(게시중/게시만료) 조회 및 삭제<br /> - 게시만료 타입에 따라 상태 구분 <br />- 리뷰 등록/수정/삭제/조회 | **판매페이지** <br /> - 판매 가능한 숙박권 조회 <br /> - 판매할 상품 가격 및 종료날짜, 캐치특가 여부 및 종료날짜 및 가격, 판매자한마디 설정 및 등록<br /> 판매한 상품 수정/삭제<br /><br/> **메인 페이지** <br /> - 캐치특가 상품 및 리뷰 조회 <br /><br /> **캐치특가 페이지**<br /> - 캐치특가 상품 조회<br /> -무한 스크롤 기능 <br /> -지역, 드롭다운 필터를 사용한 세분화 조회 <br /><br/> **리뷰 페이지** <br /> - 무한 스크롤 기능<br /><br /> **공동 컴포넌트** <br /> - 모달 구현 | **구매 페이지**<br/> - 상품 정보 조회<br/> - 이용자 정보 등록<br/> - 결제 수단 설정 <br/><br/> **결제 완료 페이지**<br/> - 상품 정보 / 예약 정보 조회 <br/><br/> **검색 결과 페이지**<br/> - 필터링, 무한스크롤 기반 한 상품 리스트 조회 <br/> - 지도에서 상품 위치, 상품 정보 조회<br/><br/> **공동 컴포넌트** <br/> - 상단 app bar / 하단 nav bar 구현 | **상세검색 페이지** <br /> - 지역선택 및 숙소유형 버튼 필터 구현 <br /> - 범위선택 달력 및 인원 수 선택 카운터 구현<br /><br/> **체크인 마감임박(메인 & 페이지)** <br /> - 일주일 조회 및 선택 가능한 달력 구현 <br /> - 지역선택 필터 재사용 및 적용<br /> - 상품 무한 스크롤 구현<br /><br/> **상품 상세페이지** <br /> - 상품 이미지 스와이퍼(캐러셀) 구현<br /> -찜하기 기능 구현<br /><br/> **공동 컴포넌트** <br /> - 버튼 구현 (슬라이드, 체크박스, 찜버튼) <br /> - ToastAlert 구현 및 커스텀 훅 추가 구현<br /> - 상품 공동 컴포넌트 구현<br /> - 단일선택 및 범위선택 달력 구현<br /> - 검색 필터 공동 컴포넌트화 | **채팅** <br /> - 실시간 채팅을 위한 웹소켓 연결 <br /> - 구매자/판매자간 채팅방 생성 기능 구현 <br /> - 채팅 주고 받기 기능 구현 <br /> - 네고하기 및 네고 가격 결제 기능 구현 | | ||
|
||
<br/> | ||
<br/> | ||
|
||
|
||
<br/> | ||
|
||
## 💡 기능 소개 | ||
(설명추가) | ||
|
||
### 회원가입/로그인 | ||
|
||
### 마이페이지 | ||
|
||
### 채팅 | ||
|
||
### 구매 | ||
|
||
### 판매 | ||
|
||
## ⚒️ 기술 스택 | ||
|
||
### SKILL & UI | ||
<img src="https://img.shields.io/badge/Next.js-000?logo=nextdotjs&logoColor=fff&style=for-the-badge"> <img src="https://img.shields.io/badge/typescript-3178C6?style=for-the-badge&logo=typescript&logoColor=white"> <img src="https://img.shields.io/badge/Tailwind%20CSS-06B6D4?style=for-the-badge&logo=Tailwind%20CSS&logoColor=white"> <img src="https://img.shields.io/badge/MUI-007fff?style=for-the-badge&logo=MUI&logoColor=white"> | ||
### SKILL & UI | ||
|
||
<img src="https://img.shields.io/badge/Next.js-000?logo=nextdotjs&logoColor=fff&style=for-the-badge"> <img src="https://img.shields.io/badge/typescript-3178C6?style=for-the-badge&logo=typescript&logoColor=white"> <img src="https://img.shields.io/badge/Tailwind%20CSS-06B6D4?style=for-the-badge&logo=Tailwind%20CSS&logoColor=white"> <img src="https://img.shields.io/badge/MUI-007fff?style=for-the-badge&logo=MUI&logoColor=white"> | ||
|
||
### CLOUD & SOCKET | ||
|
||
<img src="https://img.shields.io/badge/amplify-ff9900?style=for-the-badge&logo=aws%20amplify&logoColor=white"> <img src="https://img.shields.io/badge/sockjs-000000?style=for-the-badge&logo=npm&logoColor=white"> <img src="https://img.shields.io/badge/stompjs-0366D6?style=for-the-badge&logo=npm&logoColor=white"> | ||
|
||
### VALIDATION & UTILITY | ||
|
||
<img src="https://img.shields.io/badge/zod-3e67b1?style=for-the-badge&logo=Zod&logoColor=white"/> <img src="https://img.shields.io/badge/React%20Hook%20Form-ff4154?style=for-the-badge&logo=React%20Hook%20Form&logoColor=white"> <img src="https://img.shields.io/badge/lodash-3492ff?style=for-the-badge&logo=lodash&logoColor=white"> | ||
|
||
### LINT | ||
|
||
<img src="https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white"> <img src="https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge&logo=prettier&logoColor=F7BA3E"> <img src="https://img.shields.io/badge/husky-9A6946?style=for-the-badge&logo=npm&logoColor=white"> | ||
|
||
### TEST | ||
|
||
<img src="https://img.shields.io/badge/jest-c21325?style=for-the-badge&logo=jest&logoColor=white"> <img src="https://img.shields.io/badge/testing%20library-323330?style=for-the-badge&logo=testing-library&logoColor=red"> <img src="https://img.shields.io/badge/playwright-2EAD33?style=for-the-badge&logo=playwright&logoColor=white"> | ||
|
||
### SERVER & CLIENT STATE MANAGEMENT | ||
|
||
<img src="https://img.shields.io/badge/React%20Query-ff4154?style=for-the-badge&logo=React%20Query&logoColor=white"> <img src="https://img.shields.io/badge/axios-5a29e4?style=for-the-badge&logo=axios&logoColor=white"> <img src="https://img.shields.io/badge/Recoil-3578E5?style=for-the-badge&logo=redux&logoColor=white"> | ||
|
||
### SCROLL & ANIMATION | ||
|
||
<img src="https://img.shields.io/badge/react%20infinite%20scroll%20component-E3FF73?style=for-the-badge&logo=npm&logoColor=white"> <img src="https://img.shields.io/badge/framer%20motion-0055FF?style=for-the-badge&logo=framer&logoColor=white"> | ||
|
||
### DATE | ||
|
||
<img src="https://img.shields.io/badge/momnet-61B2A7?style=for-the-badge&logo=npm&logoColor=white"> <img src="https://img.shields.io/badge/datefns-770C56?style=for-the-badge&logo=datefns&logoColor=white"> | ||
|
||
### IDE & OTHERS | ||
|
||
<img src="https://img.shields.io/badge/notion-000000?style=for-the-badge&logo=notion&logoColor=white" /> <img src="https://img.shields.io/badge/figma-%23F24E1E?style=for-the-badge&logo=figma&logoColor=white" /> <img src="https://img.shields.io/badge/Visual%20Studio%20COde-007acc?style=for-the-badge&logo=visual%20Studio%20COde&logoColor=white"> | ||
|
||
<br/> | ||
<br/> | ||
<br/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters