lequocvuong/together-party-tonight-server

🍃 투바투 : 실시간 거리 기반 모임 추천/신청 서비스

together-party-tonight-server

🍃 TOGETHER-PARTY-TONIGHT(투바투) : 실시간 거리 기반 모임 추천/신청 서비스

서비스 설명

실시간 거리 기반으로 모임을 추천해주고 사용자의 취향에 맞게 모임을 신청하고 정산할 수 있는 웹사이트

• 최소 기능 (MVP)

  • 인증 권한 : 로그인, 회원가입, 토큰재발급 (jwt), 소셜로그인, 메일링
  • 검색 : 카테고리별, 키워드별, 인원수, 모집상태
  • 댓글 기능
  • 채팅 기능
  • 실시간 알림 기능
  • 평점 및 리뷰 기능
  • 거리/주소 기반 추천 서비스 + 맵 연동
  • 모임 신청 및 승인/거절 기능
  • 모임 조회/수정/추가/삭제 기능
  • 정산/결제 기능

• OUT OF SCOPE

  • SNS 장소 공유

공통 컨벤션 (Convention)

🌴 Branch 전략

• Git Flow

항목	설명
main	기준이 되는 브랜치로 제품을 배포하는 브랜치
develop	개발 브랜치로 개발자들이 이 브랜치를 기준으로 각자 작업한 기능들을 Merge
feature	단위 기능을 개발하는 브랜치로 기능 개발이 완료되면 develop 브랜치에 Merge
release	배포를 위해 main 브랜치로 보내기 전에 먼저 QA(품질검사)를 하기위한 브랜치
hotfix	master 브랜치로 배포를 했는데 버그가 생겼을 떄 긴급 수정하는 브랜치

• Git Flow 과정

  • master 브랜치에서 develop 브랜치를 분기함
  • 개발자들은 develop 브랜치에 자유롭게 커밋을 함
  • 기능 구현이 있는 경우 develop 브랜치에서 feature/* 브랜치를 분기합니다.
  • 배포를 준비하기 위해 develop 브랜치에서 release/* 브랜치를 분기합니다.
  • 테스트를 진행하면서 발생하는 버그 수정은 release/* 브랜치에 직접 반영합니다.
  • 테스트가 완료되면 release 브랜치를 master와 develop에 merge함

• 보통 main <- release <- develop(default) <- feature

  • 모든 기능 구현은 feature을 이용해 브랜치를 분기해 개발 후 devleop으로 pull-request 하기!
  • 직접 develop으로 push ❌❌

• 예시 : feature/login

🍕 Commit 전략

항목	설명
ADD	(새로운) 기능 추가
UPDATE	기능 수정 or 코드 리팩토링
BUGFIX	버그 or 이슈 수정

• 타입은 태그와 제목으로 구성되고, 태그는 영어로 쓰되 첫 문자는 대문자로 함
• 태그 : 제목의 형태이며, :뒤에만 space가 있음에 유의함
• 예시 : git commit -m "[ADD] : header feature implement"
  • 추가 본문 메시지를 쓸 경우에도 메인 제목은 위와 같이 동일하게 작성

🍭 PR 전략

• PR Template에 따름

Backend

✨ 기술 설명

SpringBoot, Spring Data JPA, JWT 를 이용해 Back-end 개발

🔥 기술 스택

항목	기술 스택
사용언어	JAVA, SpringBoot
DB	Redis, Amazon RDS(MySQL)
API 명세	Swagger
보안	JWT, Spring Security
CI/CD	AWS EC2, AWS S3, AWS RDS, Github Actions

🔅 코드 컨벤션

항목	규칙
Package	camelCase
File	PascalCase
Constant	UPPER_SNAKE_CASE
Variable	camelCase
Function	camelCase

✔ 추가 라이브러리 & 버전 정보

항목	버전 정보
JAVA	v11
SpringBoot	v2.7.12
Swagger	v2.9.2

ERD

---

🔗 TOGETHER-PARTY-TONIGHT(투바투)