📖 About project

더 이상 독서는 혼자만의 취미가 아니다❌ 책을 사랑하는, 책과 가까워지고 싶은, 혹은 비슷한 사람들끼리 취미를 공유하고 싶어하는 모두가 모여 하나의 마을을 형성하는 book village는 사용자 모두가 이웃처럼 서로의 지식을 나누고 책을 공유합니다. 함께하는 독서 습관을 만들어주는 서비스, book village에 오신 걸 환영합니다!

---

🔗 Deployed Link

⛪ Book Village

---

🗣️ Project

🗓️ 2023.01.03 - 2023.02.03

📺 Presentation Video

📑 Presentation document

---

🖥️ Service operation

메인 화면 1	메인 화면 2	소셜 로그인 1

소셜 로그인 2	나눔글 등록 및 수정	나눔글 목록

나눔글 이미지 업로드	나눔글 댓글	나눔 상태 토글

나눔 게시글 검색	요청글 등록	요청글 수정

요청글 댓글	요청글 검색	도서 평점 등록

도서 평점 수정 및 삭제	마이페이지 1	마이페이지2

---

🧰 Skill stack

🔧 System Architecture

FE

BE

👬 Cooperation tools

---

👥 Teammates

FE

@aemaaeng	@yejin32	@Yoonji23	@cjsrmachs
김혜민	장예진	최윤지	최창훈

BE

@SsangSoo	@orioncsy	@pjongk148
김성수	채승윤	박종혁

📑 Project Rules

Branch Strategy

• main / dev 브랜치 기본 생성
• main과 dev로 직접 push 제한
• PR 전 최소 1인 이상 승인 필수

Git Convention

• feat : 기능 추가
• fix : 오류 수정
• hotfix : 급한 오류 수정
• docs : 문서 수정
• refactor : 리팩토링
• test : 테스트 코드
• style : 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
• design : CSS 등 사용자 UI 디자인 변경

Code Convention

BE

• 패키지명 전체 소문자
• 클래스명, 인터페이스명 CamelCase
• 클래스 이름 명사 사용
• 상수명 SNAKE_CASE
• Controller, Service, Dto, Repository, mapper 앞에 접미사로 통일(ex. MemberController)
• service 계층 메서드명 create, update, find, delete로 CRUD 통일(ex. createMember)
• Test 클래스는 접미사로 Test 사용(ex. memberFindTest)

FE

• styled-Component 변수명 S + 변수명 (ex. Swrap)
• styled-Component는 return문 위에 작성
• 크게는 styled-Component, 그 안에서 className 사용
• Event handler 사용 (ex. handle ~)
• export방식 (ex. export default ~)
• 화살표 함수 사용

Communication Rules

• Discord 활용
• 정기 회의

📋 Documents

📜 API 명세서

📜 요구사항 정의서

📜 ERD

📜 테이블 명세서

📜 화면 정의서