1차 과제 (2024년 12월 28일 → 2025년 1월 12일)

1. 프로젝트 협업 방식 설정

• 백엔드 파트장: 강슬미

• 백엔드 파트 정기 회의: 비대면, 1차 과제 전까지 수시로 진행(9일 오후 8시)

• GitHub 레포지토리 생성

  https://github.com/UMC-CodePlay/CodePlay-BE

• 브랜치 전략 수립

  

  • main: 배포 이력을 관리하기 위한 브랜치 → 배포후 태그 붙이기
  • develop: 개발이 완성된 기능(feature)들을 병합하기 위한 브랜치
  • 개인 레포로 fork한 후, pr 올리는 것으로 진행

• 패키지 전략 수립

  • 계층형 : 백엔드에서 처리할 요청이 많지 않으므로 도메인형보다 효율적이라 판단

    

• 코드 컨벤션 설정

  • 이름 규칙: 카멜케이스(camelCase)
  • Boolean 타입 변수명: 접두어를 is/has 등으로 넣기
  • spotless 과 같은 스타일 도구 사용해서 코드 포맷팅 관리
    • 네이버 코드 컨벤션 따르기
    • git action 사용해서 push 전에 spotless 실행되도록 진행

• PR 규칙 정하기

  • message 제목 태그

    

  • commit message: 할당된 이슈와 관련된 commit이면 #이슈번호 , 제목태그 붙이기

  • issue 제목: [제목태그] 해야할 일

  • pr 제목: [제목태그] 한 일(#이슈번호)

  • merge는 ci(build) 통과시에 개인이 직접 진행.

    • 이때 squash and commit으로 강제

• 템플릿 설정

  • PR 템플릿

    https://github.com/UMC-CodePlay/CodePlay-BE/blob/Develop/.github/PULL_REQUEST_TEMPLATE.md

  • Issue 템플릿

    1. bug 템플릿

       https://github.com/UMC-CodePlay/CodePlay-BE/blob/Develop/.github/ISSUE_TEMPLATE/bug_report.md

    2. feature 템플릿

       https://github.com/UMC-CodePlay/CodePlay-BE/blob/Develop/.github/ISSUE_TEMPLATE/feature_request.md

    3. 그외 템플릿

       https://github.com/UMC-CodePlay/CodePlay-BE/blob/Develop/.github/ISSUE_TEMPLATE/etc-issue-template.md

2. 프로젝트 기본 설정 및 ERD 설계

• Spring Boot 프로젝트 설정 완료

• DB 설계 (ERD)

  https://www.erdcloud.com/d/hLLBBWxzR54Dog5AJ

  

• 기본 응답 형식 설계 (응답 통일)

  • 워크북 방식과 동일

    // 성공
    {
      "isSuccess": true,
      "code": "200",
      "message": "OK",
      "result": "Operation Successful"
    }
    
    // 실패
    {
      "isSuccess": false,
      "code": "400",
      "message": "Bad Request",
    }
    

• 공통 예외 처리

  • 워크북 방식과 동일

    

• 인증/인가

  • Spring Security + JWT 인증 방식으로 진행하기로 결정
  • 기본 + 소셜 로그인으로 OAuth Login 역시 사용 예정

3. API 구현 시작(20%)