dan-mu-zi/simple-board

프로젝트명

프로젝트에 대한 간단한 소개 및 목적을 기술합니다.

관련 링크

• 프로젝트 설계도(Figma)
• 데이터베이스 설계도(ERD Cloud)
• API 문서(구글 시트)

목차

• 기술 스택
• 개발 컨벤션
  • 코드 컨벤션
  • 커밋 컨벤션
  • 이슈 관리
  • 브랜치 전략

기술 스택

프로젝트를 구현하는 데 사용된 기술들을 나열합니다.

• Java
• Spring Boot

개발 컨벤션

코드 컨벤션

캠퍼스 핵데이 Java 코딩 컨벤션

커밋 컨벤션

[커밋 양식]

- #[이슈번호] - 동작(feat, fix, ...) - [메인 내용]  
- ex) #3-feat-게시판 생성 로직 구현  
- ex) #3-fix-게시판 수정 로직 버그 수정  

[커밋 컨벤션]

- feat : 새로운 기능 추가  
- fix : 버그 수정  
- refactor : 코드 리펙토링
- docs : 문서 수정
- test : 테스트 코드 작성 / 수정
- chore : 자잘한 수정 (오타 등)
- build : 빌드 관련 파일에 대한 커밋
- move : 파일 이동
- rename : 파일 이름 변경
- delete : 파일 삭제
- config : application.yml 파일에 대한 수정
- style : 코드 컨벤션 및 별도 코드 스타일 수정

이슈 관리

project 기반으로 이슈 관리

브랜치 전략

[브랜치 양식]

- [목적]/#[이슈번호]-[세부설명]
- ex) feature/#4-service-impl
- 이슈기반 브랜치

[목적 목록]

- feature
- fix
- docs

simple-board's Issues

readme 에 커밋 컨벤션 수정

커밋 시 #[이슈 번호] 뒤에 띄어쓰기가 필요하므로 수정해야함

양식
#[이슈 번호] - [구분] - [작업 내용]

Swagger 적용하기

실제 서비스에서 API 를 확인할 수 있도록 Swagger를 통해서 서비스를 제공하자.

프로젝트 초기화

백엔드 프로젝트 생성
gitignore 작성
gitignore 참고 사이트

리드미 초안 작성

적어야 할 내용

• Figma 링크

• ERD Cloud 링크

• 구글 시트 링크

• 기술 스택

• 커밋, 이슈, 브랜치 컨벤션

Post 컨트롤러 구현하기

게시판 기능을 사용할 수 있도록 컨트롤러를 구현해보자.

댓글 서비스 구현

ERD Cloud 를 기반으로 Comment 엔티티, 레포지토리, 서비스, 컨트롤러, 테스트의 스켈레톤 코드를 구현할 것.

코드 컨벤션 적용하기

intellj 에서 네이버 코드 컨벤션이 import 되지 않는 오류가 있다.
유효한 자료를 찾아서 링크를 올리고 방법까지 공유하자.

유저 서비스 구현

ERD Cloud 를 기반으로 유저 엔티티, 레포지토리, 서비스, 컨트롤러, 테스트의 스켈레톤 코드를 구현할 것.

User 인식 도입하기

Spring security 던 다른 기술이던 찾아서 User 인식하게 해야함
이후에 컨트롤러에서 유저 가변적으로 작동되게 변경해야함

게시판 서비스 구현

ERD Cloud 를 기반으로 Post 엔티티, 레포지토리, 서비스, 컨트롤러, 테스트의 스켈레톤 코드를 구현할 것.