추천 기반 도서 큐레이션 서비스 '후즈북'

팀 명 : 📖 책4냥꾼
프로젝트 명 : 후즈북
프로젝트 기간 : 2023.06.28 - 2023.07.24
프로젝트 팀원 : 이경주, 김동욱, 한주영, 최연수, 유지예, 정지원
배포 링크 : 📚 후즈북
요구사항 정의서: 사용자 요구사항 정의서

💼 Team

후즈북의 훌륭한 팀원들을 소개합니다.

이경주	김동욱	한주영	최연수	유지예	정지원
BE(팀장)	BE(팀원)	BE(팀원)	FE(부팀장)	FE(팀원)	FE(팀원)
Curation / Book	Member	Member	Pages	Pages	Pages
- CRUD - BEST/NEW List - Category filtering	-회원가입 -회원정보 수정 -회원탈퇴	- jwt 로그인 - oauth 소셜로그인	- Best Curation - New Curation - Curation Write - Curation Edit - Curation Detail	- SignUp - SignIn - MainPage	- MyPage - UserPage - Curation Detail Page
Category	MyPage	Curation	Components	Components	Components
- CRUD	- 작성한 글 조회 - 좋아요한 글 조회 - 구독한 멤버 조회	- 좋아요 기능 - 댓글 CRUD	- Category Tag - Book Info - Curation Profile Info - Curation Detail Info - Quill Editor - Select Box	- ImageUpload - GNB - Footer - Button - Input - Label - Loading - Slider - SweetAlert	Form / Info - ProfileForm - ProfileInfo - ProfileOut Card - ProfileCard - CurationCard - SubCuratorCard List - WrittenList - LikeList - CuratorList Modal - Modal - SearchModal
Image Upload	Subscribe	Authentication	Features	Features	Features
- AWS S3 Image upload	- 구독 기능	- 인가설정	- Curation CRUD - Curation Visibility - Curation Image Upload	- 일반 /소셜 로그인 - 일반 /소셜 회원가입 - basic validation - useInput hook - image upload	- Reply CRUD - RepliesSlice - Subscribe - Like - Pagination

🐱 Github

Name	이경주	김동욱	한주영	최연수	유지예	정지원
Github ID	@Kyungju	@WOOK0112	@HanJuYoung309	@ella-yschoi	@jiye-7	@jeongjwon

⚙️ Tools

Github	Discord	Notion

🖥 Front-end

HTML	CSS	TypeScript	React	Redux Toolkit	Styled Components	TailwindCSS	React Quill

🔒 Back-end

Java	Spring	spring security	Spring Boot	JWT	MySQL	Gradle	OAuth2	AWS

🌟 Pages & Features

일반 회원가입 / 로그인	OAuth 회원가입 / 로그인

큐레이션 발행	큐레이션 수정 / 삭제

메인에서 3가지 리스트에 따라 해당 페이지로 이동 카테고리 필터	구독 / 좋아요 / 댓글

👩🏻‍💻 Wireframe

Figma 링크

🛢 DB Diagram

💡API 명세서

https://documenter.getpostman.com/view/25121215/2s946mbAJh

API 명세서 자세히 보기

📎 Git

🌲 Branch

• main : 서비스 운영 브랜치
• dev : 메인 브랜치 배포전 릴리즈 브랜치
• feat/fe-기능 : FE 개발 환경 브랜치
• feat/be-기능 : BE 개발 환경 브랜치

📌 PR 메시지 템플릿 📌

## 개요

- 논문 상세페이지 접속 시 논문 정보 api를 불러와서 상세정보를 보여줍니다.
- DOI 클릭 시 논문 원본으로 이동합니다.

## 작업사항

- 논문 상세페이지 레이아웃 구현
- 상세페이지 url 쿼리로 논문 정보 api 호출

### 참고사항

- reference에 title이 없으면 보이지 않도록 설정했습니다.
- api 호출 시 에러 처리는 추후 구현 예정입니다.

### 스크린샷

- gif, 이미지 파일 등

## 리뷰 요청사항

- 참고사항의 예외 처리 이외에 추가로 예외 처리가 필요한 부분이 있을 지 조언 부탁드립니다.

📌 코드리뷰 & 머지 규칙 📌

### PR 및 merge 규칙

1. push 하기 전 `git pull origin dev` 해서 충돌을 없앤다.
2. dev 브랜치로 merge하기 전 PR 한다.
3. Merge 후 브랜치는 삭제한다.
4. PR 리뷰 하나 이상이 달려야 main 브랜치로 merge될 수 있도록 한다.
5. 리뷰는 각 FE & BE 팀원 모두에게 받는다. (필요 시 팀원들과 퀵하게 논의)
6. conflict이 나지 않으면 디스코드 공유 후, 최종 merge는 본인이 한다.

### PR 및 merge 규칙(백엔드)

1. 세부기능 단위는 PR후 리뷰등록후 승인한후 merge(PR올린사람이 merge), merge 후에는 해당 브랜치 삭제
2. 논의가 필요한 PR의 경우 리뷰등록 후에, 팀원끼리 같이 시현 후에 승인하고 merge한다

✉️ Commit Message

Message	설명
[feat]	새로운 기능을 추가할 경우 ex) [feat] 로그인 기능 추가
[fix]	버그 수정에 대한 커밋
[docs]	문서를 수정한 경우
[refactor]	효율을 위한 코드 리팩토링에 대한 커밋
[style]	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
[docs]	문서 및 주석 수정
[test]	테스트 추가, 테스트 리팩토링 (코드 변경 X)
[chore]	빌드 테스트 업데이트, 패키지 매니저를 설정하는 경우 (코드 변경 X)
[design]	CSS 등 사용자 UI 디자인 변경
[comment]	필요한 주석 추가 및 변경
[rename]	파일 혹은 폴더명을 수정하는 경우
[remove]	사용하지 않는 파일 혹은 폴더를 삭제하는 경우

🔥 Our Team Culture

📌 우리 팀의 문화 📌

🌟 스크럼

- 오전 스크럼 (10:00 ~ 10:20): 전날 완료한 작업 / 오늘 진행할 작업 / 고민 및 공유 상황 등을 논의합니다.
- 오후 스크럼 (17:00 ~ 17:20): 중간 진행 상황 / 고민 및 공유 상황 등을 논의합니다.

🌟 회의와 소통

- 소그룹 Zoom: FE&BE 주 1회
- Discord: FE, BE 각 채널을 통해 소통

🌟 팀 코어 타임

- 09:00 ~ 18:00

🌟 기타 규칙

- 휴가나 개인사정 미리 공유
- Task 진행 상황 최대한 자주 공유
- 작업 시 어려움은 <고민 Limit Time> 2시간 까지
- 작업 범위를 최대한 작게 쪼개서 진행