📚 북스테어즈는 어떤 서비스인가요? 🧐

진짜 독서가들의 독서법, 북스테어즈 💡

북스테어즈는 여러분들의 보다 똑똑한 독서를 돕습니다!
북스테어즈 바로가기

SOPT 29th APPJAM

• 프로젝트 기간: 2021.12.18 ~
• 릴리즈: 2022.03.17 ~
• Notion
• API 명세서
• 코드 컨벤션
• Git 전략

🐉 워크플로우

🛠 기술 스택

🌲 Git 전략

🏗 아키텍쳐

🗂 프로젝트 폴더 구조

📦src
 ┣ 📂config
 ┃ ┗ 📜index.ts
 ┣ 📂controller
 ┃ ┣ 📜auth.ts
 ┃ ┣ 📜book.ts
 ┃ ┣ 📜review.ts
 ┃ ┗ 📜user.ts
 ┣ 📂interface
 ┃ ┣ 📜IBook.ts
 ┃ ┣ 📜IReview.ts
 ┃ ┗ 📜IUser.ts
 ┣ 📂library
 ┃ ┣ 📜checkValidation.ts
 ┃ ┣ 📜constant.ts
 ┃ ┣ 📜convertSnakeToCamel.ts
 ┃ ┣ 📜response.ts
 ┃ ┗ 📜returnCode.ts
 ┣ 📂loader
 ┃ ┗ 📜db.ts
 ┣ 📂middleware
 ┃ ┣ 📜authMiddleware.ts
 ┃ ┗ 📜upload.ts
 ┣ 📂models
 ┃ ┣ 📜Book.ts
 ┃ ┣ 📜Review.ts
 ┃ ┗ 📜User.ts
 ┣ 📂others
 ┃ ┗ 📂slack
 ┃ ┃ ┣ 📜slack.ts
 ┃ ┃ ┗ 📜slackAPI.ts
 ┣ 📂router
 ┃ ┣ 📜auth.ts
 ┃ ┣ 📜book.ts
 ┃ ┣ 📜index.ts
 ┃ ┣ 📜review.ts
 ┃ ┗ 📜user.ts
 ┣ 📂service
 ┃ ┣ 📜auth.ts
 ┃ ┣ 📜book.ts
 ┃ ┣ 📜review.ts
 ┃ ┗ 📜user.ts
 ┣ 📂test
 ┃ ┣ 📂library
 ┃ ┃ ┗ 📜checkValidation.spec.ts
 ┃ ┗ 📂service
 ┃ ┃ ┣ 📜auth.spec.ts
 ┃ ┃ ┣ 📜book.spec.ts
 ┃ ┃ ┣ 📜review.spec.ts
 ┃ ┃ ┗ 📜user.spec.ts
 ┗ 📜index.ts

💌 커밋 컨벤션

제목	내용
feat	새로운 기능 / 특징
fix	버그를 고침
hotfix	현재 프로덕션에 크리티컬한 버그를 고침
chore	프로덕션 코드가 바뀌지 않는 가벼운 일들
docs	도큐먼트 / 문서화 업데이트
refactor	프로덕션 코드를 리팩토링
test	테스트 코드 추가 및 업데이트
deps	Dependency와 관련 있는 내용

👨‍👧‍👦 Team

🙋 고성용	🙋 장서현	🙋 이동근
서버 개발자	서버 개발자	서버 개발자
프로젝트 세팅 웹 배포 서버 배포 DB 설계	테스팅 서버 배포 DB 설계	디버깅 웹 배포 서버 배포 DB 설계

📄 API

Route	URI	HTTP 메서드	설명
Auth	/auth/email/?email=	GET	이메일 유효성 검사
	/auth/nickname/?nickname=	GET	닉네임 유효성 검사
	/auth/login	POST	유저 로그인
	/auth/signup	POST	회원가입
	/auth/check	GET	로그인 여부 판별
User	/user/myInfo	GET	내 정보 조회
	/user/img	PATCH	프로필 사진 수정
Book	/book	POST	서재 / 리뷰에 책 추가하기
	/book	GET	서재 책 전체 조회
	/book/pre	GET	서재 독서 전 조회
	/book/peri	GET	서재 독서 중 조회
	/book/post	GET	서재 독서 완료 조회
Review	/review/before/:reviewId	PATCH	독서 전 단계
	/review/:reviewId/question-list	GET	질문 리스트 조회
	/review/now/:reviewId	PATCH	독서 중 단계
	/review/:reviewId	GET	리뷰 조회
	/review/:reviewId	PATCH	리뷰 수정
	/review/:reviewId	DELETE	리뷰 삭제
	/review/:reviewId/pre	GET	독서 전 리뷰 조회
	/review/:reviewId/peri	GET	독서 후 리뷰 조회

🛠 Version

Version	Content	Detail	Date
1.0.0	initial version	📄	2022.02.06
1.0.1	bug fix, add api	📄	2022.02.10
1.0.2	bug fix, modify api	📄	2022.02.21
2.0.0	switch database from postgreSQL to mongoDB	📄	2022.03.03
2.0.1	bug fix	📄	2022.03.06