Skip to content

depromeet/KnockKnock-Backend

Repository files navigation

readme banner


푸시알림 커스텀 서비스, Knocknock


readme 0 readme 01 readme 2 readme 3 readme 4


1. 서버 구동 가이드

  • java 11 버전, gradle , mysql , 도커가 필요합니다!

  • mysql 을 로컬에서 실행시킵니다.

  • docker-compose로 redis를 구동시킵니다.

$ docker-compose up

$ ./gradlew build

$ java -jar ./build/libs/KnockKnock-Backend-0.0.1-SNAPSHOT.jar

2. Erd


ㄷㄱㅇ

3. 서버 아키텍쳐

ㄷㄱㅇ

4. 선생님들

💻 개발자 선생님들 💻

백엔드, 팀장 백엔드 백엔드
이서준 이찬진 배정은

leeseojune53

ImNM

mybloom
AOS 팀장 AOS AOS AOS
이영준 황규일 조준장 최현정

leeyjwinter

Gyuil-Hwnag

junjange

hyunjung-choi

🎨 하늘같은 디자인 선생님들 🎨

디자인 디자인 디자인
김나영 박수연 진승희

김나영

박수연

진승희

5. KnockKnock 백엔드 팀의 규칙

5.1. 개발 프로세스

  1. issue 생성
  2. issue 기반 branch 생성
  3. issue와 관련된 feature 개발 완료
  4. PR 혹은 merge commit 생성시에도 커밋 메세지 규칙에 맞춰 작성
  5. PR이 주요 branch로 merge되기 위한 조건
    • 최소 1명의 review의 approve
    • CI로 인한 build success
    • test case 작성 - optional
  6. merge 후 feature branch 제거
  7. issue close

5.2. 커밋 규칙

  • 커밋메세지

다음은 커밋메세지의 형식입니다.


  CommitType :: (#issue number) Subject

  • Commit Type

다음은 커밋타입 형식입니다.

CommitType 설명
📑 :: 파일 생성 및 구조 변경
⚡️ :: 기능 업데이트
⚰️ :: 기능 삭제
🐛 :: 버그 수정
♻️ :: 코드 리펙토링
📝 :: 문서 작성 및 수정
⚙️ :: 프로젝트 세팅
🧪 :: 테스트 코드 추가
🚀 :: 새 버전 릴리즈 ( 커밋은 아니지만😏
🔀 :: Merge or PR
  • issue number

위에 #issue number 이라고 기재한 부분:

merge commit이나 PR을 날릴때에만 사용한다. ( ) 안에 작성한다. #뒤에 개발한 브런치가 기반을둔 issue number을 기입한다.

  • Subject

커밋메세지 형식의 Subject 부분에 기재

50자를 넘기지 않게 명령형으로 작성한다. 한국어로 작성한다. 어떻게 보단 무엇을, 에 초점을 두고 작성한다.

"~수정 했다""~수정"

"Add~""~추가"
  • Example
🐛 :: [MainPage] 헤더가 안보이는 버그 수정
🐛 :: (#19)[FeedServiceImpl] 피드 버그 로직 수정
🚀 :: v1.0.0
📝 :: README 파일 수정

5.3. 브랜치 규칙

기본적으로 GitFlow를 따릅니다

  • Feature Branch
Feature/{issue number}\_{todo}