서비스 소개

여러분의 리뷰로 개인카페를 채워주세요!
전국의 개인 카페만을 위한 공간을 마련한 곳, 바로 BLANK입니다.

---

핵심 기능

• 개인 카페에 대한 리뷰를 SNS 게시글 형식으로 작성하여 유저와 유저, 유저와 사장유저 간의 양방향 소통 가능
• 사장 유저의 경우 자신의 카페 페이지를 개설 후 관리해서 유저에게 정보를 제공하고 홍보
• 일반 유저의 경우 카페 신청 기능을 통해 카페 페이지 개설 신청 후 리뷰 작성 가능
• 관리자 페이지에서 등록된 카페 페이지 관리, 카페 페이지 개설 신청 내역 관리 및 조회

---

서비스 아키텍처

---

기술 스택

develope tool

언어

프레임 워크

보안

배포

CI/CD

DB

---

ERD

---

커밋 컨벤션

양식

[type] 제목
<BLANK LINE>
본문
<BLANK LINE>
꼬릿말

• type

  • feat : 새로운 기능에 대한 커밋
  • fix : build 파일(배포 된 시점)에 대한 커밋
  • chore : 자잘한 수정에 대한 커밋
  • docs : 문서 수정에 대한 커밋
  • style : 코드 스타일 혹은 포맷 등에 관한 커밋
  • refactor : 코드 리팩토링에 대한 커밋

• 제목

  • 작성 요령
    • type과 제목 사이 공백 한칸 넣기
    • 명령문으로 작성! 과거형 사용x
  • 포함 되어야 할 내용
    • 어디에 ex) 00Controller에서 or 마이페이지에서
    • 무엇을했는가 ex) 00기능을 추가 or ~을 수정

• 본문

  • 제목에 대한 이유가 들어갈 수 있도록 작성

• 꼬릿말

  • 어떤 이슈에서 왔는지와 같은 참조 정보를 추가하는 용도로 사용(추가이기 떄문에 필수가 아님)
  • 이후 이슈번호 관리에 대한 공부 이후 적극적으로 사용할 수 있으면 좋겠다.

reference

https://koreapy.tistory.com/1150

---

코드 컨벤션

DTO

DTO 형식

• Http 응답 메시지 작성 시 Body에 들어갈 Dto는 한개만 사용(ResponseDto<T>)
• ResponseDto의 제네릭스안에 들어갈 여러 형태들을 클래스로 정의(README에서는 Body형식이라고 표기)
• Dto 패키지 안에는 ResponseDto<T>와 여러 패키지로 구성

Dto패키지 안의 여러 패키지의 구성

여러 패키지의 명명규칙은 "기능명/기능과 관련된 단어"

• RequestDto의 명명규칙은 "기능명/기능과 관련된 단어+RequestDto"
• Body형식 클래스들의 명명규칙은 "보여지는 페이지+기능명/기능과 관련된 단어+Dto"
• Dto패키지 하위 패키지명은 Dto들의 공통된 내용을 이름으로 생성

DTO패키지 구성 예시

• ex) 게시글 작성의 RequestDto > PostRequestDto

• ex) 메인페이지에서 보여지는 게시글 리스트 > MainPostDto

• ex) 카페 페이지에서 보여지는 게시글 리스트 > CafePostDto

• Dto ------ResponseDto<T>.java
     |--------Post-----PostReqeustDto.java
                 |---------MainPostDto.java
                 |---------CafePostDto.java

---

Git 전략

우리 팀은 Git전략으로 GitHub Flow를 사용합니다.(CI/CD에 적합)

Branch 구성

• main : 릴리즈에 있어서 절대적인 역할(항상 최신버전 유지)

• hotfix : main branch에서 오류발생 시 오류 가져와서 수정 후 main으로 merge

• feature/ : main에서 뻗어나오는 branch 기능별로 branch생성
                 기능 구현 후main으로 merge

  feature/ branch는 팀원에게 얘기하고 생성할 것!!!