yapp-github/20th-all-rounder-team-2-be

[20th] All-Rounder 2팀 BackEnd

🎾 Knowlly

각자 잘아는 분야의 지식들을 서로 공유 할 수 있는 지식교환 플랫폼

기획 의도

• 새로운 분야의 지식을 배우고 싶은데 금전적 여유가 없다 → 내가 아는 지식을 공유하고 새로운 지식을 배우자

Tech Stack

• Backend

  • Java 11, Spring Boot, Spring Data JPA, MySQL
  • Spring Security, JWT, OAuth 2.0

• Infra

  • Docker, K8S

ERD : https://www.erdcloud.com/d/upxjamqGs5qPfYyXC

git convention

• 형식 : <업무명>: <작업 내용> (#이슈번호)

업무명	내용
CHORE	빌드 업무 수정, 패키지 매니저 수정
ADD	코드나 테스트, 예제, 문서 등의 추가
FIX	올바르지 않은 동작을 고친 경우
REMOVE	코드의 삭제가 있을 때
UPDATE	문서나 리소스, 라이브러리등의 수정, 추가, 보완
FEAT	새로운 기능 추가
CORRECT	주로 문법의 오류나 타입의 변경, 이름 변경 등
REFACTOR	코드의 전면적인 수정
DOCS	문서의 개정
RENAME	파일의 이름 변경
TEST	TEST 코드 관련

브랜치 전략

• main : 메인 작업 및 운영 환경의 형상 브랜치
• feature : 작업 브랜치
  • 네이밍
    • feature/ISSUE-{git issue 번호}
    • ex) feature/ISSUE-23

20th-all-rounder-team-2-be's Issues

[업무] Tag or Badge 네이밍 프론트와 협의

[문의] NCP 지원 어디까지 되는지 효선님께 문의

아래 내용을 지원하는지? 효선님이나 다른 관련 담당자께 문의

• LB
• 인증서
• DB
• 모니터링 툴

[생성] 소스코드에 엔티티 생성

• 프로젝트에 JPA 엔티티 생성
• 선행 필요 #4

[설계] 도메인 설계

지금까지 나온 기획을 바탕으로 도메인 설계하기
방식은 클래스 다이어그램이든, ERD를 그리던 자유롭게 하는 걸로

[기능] 클래스-info 등록 기능

기능

• 클래스-Info 등록 기능

할 일

• 클래스-Info 등록 기능
• 테스트 코드 작성

마감기한 (선택)

[기능] 매칭 신청서 목록 조회 기능

기능

• 매칭 신청서 목록 조회 기능

할 일

• 매칭 신청서 목록 조회 기능
• 테스트 코드 작성

마감기한 (선택)

[기능] 운영클래스 목록 조회 기능

기능

• 매칭중 클래스 목록 조회 기능
• 예정된 클래스 목록 조회 기능
• 완료된 클래스 목록 조회 기능

할 일

• 매칭중 클래스 목록 조회 기능
• 예정된 클래스 목록 조회 기능
• 완료된 클래스 목록 조회 기능
• 테스트 코드 작성

마감기한 (선택)

[기능] jacoco 테스트 커버리지 측정 도구 도입

기능

• jacoco를 현재 gradle 프로젝트에 적용하여, 테스트 커버리지를 측정할 수 있도록 한다.
• github action에서 PR 시, 테스트 측정 커버리지를 자동으로 코멘트 달 수 있도록 한다.
• 참고 문서
  • https://techblog.woowahan.com/2661/
  • https://github.com/Madrapps/jacoco-report
  • https://github.com/marketplace/actions/codecov

할 일

• #36
• github action 워크 플로 수정 - PR시 테스트 커버리지 표시될 수 있도록

마감기한 (선택)

[기능] 프로필 이미지 업로드 기능

기능

• 사용자 프로필의 이미지를 업로드 할 수 있다.

할 일

• 이미지 업로드 API 작성
• Amazon S3 연동

마감기한 (선택)

[업무] API 작업 목록 이슈화

• 와이어 프레임을 토대로 필요한 API 목록을 산출, 이슈화 한다.

[기능] 매칭 신청서 상세 조회 기능

기능

• 매칭 신청서 상세 조회 기능

할 일

• 매칭 신청서 상세 조회 기능
• 테스트 코드 작성

마감기한 (선택)

[기능] 로그인 기능

[기능] 온보딩 기능

• 프로필 정보 입력
  • 이름
  • 자기소개
  • 한줄 프로필
  • 프로필 사진

[수정] user 테이블에 email 컬럼에 제약조건 제거

수정 내용

• email 입력이 필수가 아닐 수도 있기에, email 칼럼에서 unique 및 not null 제약조건을 제거한다.

할 일

• liquibase 스키마 업데이트
• Entity 업데이트
• dbunit 및 관련 테스트 업데이트

마감기한 (선택)

[업무] ERD 추가 논의 사항

1. 클래스(Lecture)에 후기 작성 여부 표시
2. 현재 안읽은 알림이 있는지 표시하기 위해 알림 테이블에 last_read_id 속성 추가 필요성
3. 클래스의 일정이 꽉차면 게시판에서 보이지 않게 해야하고 코치의 완료된 클래스에서 추가 일정을 등록할 수 있어야함.
   하나의 일정이라도 있다면 게시판에 다시 게시.

[셋업] Github action 통해서 CI/CD 구성

• PR했을 경우 gradle test 하도록
• main 브랜치 push 됬을 경우 gradle test 하도록
  • 이후 배포 스크립트로 변경

[기능] 프로필 이미지 수정 기능

기능

• 프로필 이미지 수정 기능

할 일

• 프로필 이미지 수정 기능
• 테스트 코드 작성

마감기한 (선택)

[기능] 클래스 이미지 등록 기능

기능

• 클래스 이미지 등록 기능

할 일

• 클래스 이미지 등록 기능
• 테스트 코드 작성

마감기한 (선택)

[기능] 클래스 상세 조회

• 특정 클래스 내용을 상세히 조회할 수 있다.

[업무] 개발 서버 세팅

개발 서버 세팅

• API 서버
• 스케줄러
• DB

[기능] 등록된 클래스 검색 기능

기능

• 등록된 클래스 검색 기능

할 일

• 클래스명 기반 검색 ex) 로고 만들기
• 카테고리 기반 검색 ex) 디자인, 개발
• 테스트 코드 작성

마감기한 (선택)

[기능] 로그아웃 기능

기능

• 로그아웃 기능

할 일

• 로그아웃 기능
• 테스트 코드 작성

마감기한 (선택)

[업무] 프론트에 swagger-ui 제공

• 프론트와 협업을 위해 swagger-ui 셋팅 (실제 api까지는 아직 구현 X)
• #9 가 선행되어야 함

[설계] ERD 작성

회의 결과물 임시 ERD 기반으로 속성까지 기재된 상세한 ERD 작성.

[수정] user테이블에 identifier 컬럼 추가

수정 내용

• 내부적으로 소셜 로그인 사용자를 구분하기 위한 식별자 컬럼이 필요하다.

할 일

• ERD 상으로 식별자 컬럼 추가
• liquibase 스키마 업데이트
• Entity 업데이트
• dbunit 테스트셋 업데이트

마감기한 (선택)

[기능] Repository 작성

기능

• 작성된 Entity 각각에 JpaRepository를 작성한다.
• 작성된 Repository 에 dbunit 을 사용한 CRUD 테스트를 작성한다.

할 일

• Entity당 최소 한 개의 JpaRepository 작성
• 작성된 Repository에 CRUD 단위 테스트 작성 (dbunit 사용, 인메모리로 동작)

마감기한 (선택)

[생성] 스프링 배치 모듈 추가

• 스케줄러 도입을 위해 스프링 배치 모듈 추가 및 구동 확인

[업무] ISSUE, PR template 등록

• 이후 이슈, PR 등록이 용이하도록 템플릿을 등록하여 사용
• https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates

[기능] 등록된 클래스 목록 조회

기능

• 등록된 클래스 목록 조회 기능

할 일

• 등록된 클래스 목록 조회
• 카테고리 별 등록된 클래스 목록 조회

마감기한 (선택)

[기능] 알림 내역 조회 기능

기능

• 알림 목록 조회 기능
• 제목 필드 추가

할 일

• liquibase 스키마 업데이트
• entity 업데이트
• 테스트 업데이트
• 알림 내역 조회
• 테스트 코드 작성

마감기한 (선택)

[업무] db unit 세팅

• db 단위 테스트를 수행할 수 있는 db unit을 셋팅한다.
• h2 데이터베이스를 활용하여 반복가능한 db 테스트를 구성한다.

[기능] 클래스 등록 기능

기능

• 클래스 등록 기능

할 일

• 클래스 등록 기능
• 테스트 코드 작성

마감기한 (선택)

[생성] 기초 프로젝트 생성

이후 개발의 근간이 될 Spring boot 프로젝트를 생성함

[기능] 클래스 태그 등록 기능

기능

• 클래스 태그 등록 기능

할 일

• 클래스 태그 등록 기능
• 테스트 코드 작성

마감기한 (선택)

[기능] 모니터링 구축

• AWS CloudWatch 사용하여 모니터링 체계 구축

[수정] user 테이블에 웹사이트 컬럼 추가

수정 내용

• 기획상으로, 사용자 프로필에 웹사이트를 선택적으로 입력 가능하기 때문에, 해당 컬럼 추가가 필요하다.

할 일

• ERD 상으로 웹사이트 컬럼 추가
• liquibase 스키마 업데이트
• Entity 업데이트
• dbunit 테스트셋 업데이트

마감기한 (선택)

[도메인 설계] OAuth, JWT 인증 프로세스 다이어그램으로 표현.

[업무] javadoc 주석 추가

요청 사항

• 지금까지, 이후로도 작성되는 코드에 javadoc 주석을 추가한다.
• 클래스 단위, 메서드 단위, 필드 단위로 Javadoc 주석 기재할 것

할 일

• 엔티티 javadoc 추가

마감기한 (선택)

[기능] 클래스 카테고리 목록 조회

기능

• 클래스 카테고리 목록 조회 API

할 일

• 카테고리 데이터 DB에 넣기,
• 클래스 카테고리 목록 조회 API
• 테스트 코드 작성

마감기한 (선택)

[기능] 수강 클래스 목록 조회

기능

• 매칭중 클래스 목록 조회
• 예정된 클래스 목록 조회
• 완료된 클래스 목록 조회

할 일

• 매칭중 클래스 목록 조회
• 예정된 클래스 목록 조회
• 완료된 클래스 목록 조회
• 테스트 코드 작성

마감기한 (선택)

[업무] 알림 서버에 저장할지 프론트와 협의

[기능] 회원 탈퇴 기능

기능

• 회원 탈퇴 기능

할 일

• 회원 탈퇴 기능
• 테스트 코드 작성

마감기한 (선택)

[기능] 엔드포인트 미리 작성

기능

• 프론트엔드와 빠른 협업을 위해서, API 엔드포인트를 미리 작성해둔다.
• 작성된 엔드포인트는 비즈니스 로직 작성 전이므로, 하드코딩된 데이터를 리턴하도록 한다.
• 이후 해당 엔드포인트에 비즈니스 로직을 채워 넣는다.

할 일

• Controller 작성 및 엔드포인트 작성
• Javadoc 및 Swagger API 문서 작성
• 테스트 작성

마감기한 (선택)

[기능] 후기 목록 조회 기능

기능

• 후기 목록 조회 기능

할 일

• 후기 목록 조회 기능
• 테스트 코드 작성

마감기한 (선택)

[기능] gradle 프로젝트에 jacoco 도입 후 테스트

[기능] RefreshToken 테이블 추가

기능

• JWT 프로세스 중 RefreshToken을 저장하여 대조하는 프로세스가 있기 때문에, User 테이블과 1대1 연관을 갖는 RefreshToken 테이블을 추가한다.
• User테이블에 컬럼으로 추가할 수도 있지만 User테이블 컬럼이 이미 많기 때문에 별도 분리

할 일

• ERD 업데이트
• liquibase 스키마 업데이트
• Entity 업데이트
• 테스트 추가

마감기한 (선택)

[기능] 프로필 수정 기능

기능

• 프로필 수정 기능

할 일

• 프로필 수정 기능
• 테스트 코드 작성

마감기한 (선택)

[기능] 볼 내역 조회 기능

기능

• 볼 내역 조회 기능

할 일

• 볼 내역 조회 기능
• 테스트 코드 작성

마감기한 (선택)

[업무] 패키지명 변경

안드로이드랑 패키지 명을 통일합니다

AS-IS

kr.co.yapp

TO-BE

kr.co.knowledgerally

[설계] ERD 수정사항 반영

1. 카카오톡 ID가 어느 테이블에 종속 될 것 인지 기획 논의
2. 태그 테이블 삭제
3. 카테고리 parent_id 삭제