살아 숨쉬는 Timotae ReadMe

📅 프로젝트 기간

2021.12.21 ~

---

🔑 프로젝트 기술 스택

• Gradle
• Java 11
• SpringBoot 2.6.1
• Lombok
• ElasticSearch
• MySQL
• Spring Security

---

🚀 프로그래밍 요구사항

• 자바로만 작성 후 여러 기술들을 접목시켜 코드를 발전시켜 나간다.
• depth는 최대 3으로 한다.
• 최대한 한가지 만의 최소한의 기능만을 담당하도록 구현하자 !
• 처음부터 전부 다 구현하려 하지 말고, 기본부터 시작하자.

---

🏗️ 기능 목록 및 기능 요구사항

• 로그인

• 로그아웃

• 회원가입

• 글 작성

  • 제목
  • 내용
  • 작성자
  • 카테고리

• 글 목록

  • 글 전체 조회
  • 검색
    • 작성자
    • 제목 + 글 내용
    • 카테고리
  • 조회 수
  • 추천하기 (Hot)
  • 글번호로 정렬

• 글 상세 조회

  • 제목
  • 내용
  • 파일
  • 작성자
  • 날짜
  • 추천 수
  • 추천하기
  • 신고하기
  • 댓글/대댓글 (depth 1)
  • 댓글 수
  • 댓글 수정
  • 삭제 여부

• 글 수정 (권한 필요)

  • 제목
  • 내용
  • 업로드/삭제
  • updatedAt 수정

• 글 삭제 (권한 필요)

  • 삭제 여부 필드 변경

• 관리자 페이지

  • 회원 정보
  • 글 삭제, 수정 가능
  • 카테고리 추가

---

:thinking_face: 컨벤션

• branch 를 좀 더 자세하게 기술한다.
  • 글 저장 기능에 대한 branch 의 경우, feature 만 사용하지 않고 feature/save 와 같이 나중에 branch를 볼 때 알아 볼 수 있도록 한다.
• Commit, pull request 의 title 은 자세하게 기술한다.
  • 단순히 "글 저장 기능 구현" 이 아닌, "createPost() 후 repository 에 저장 기능 구현" 과 같이 더 자세하게 기술한다.
• 하나의 branch 에는 웬만하면 5-6개 정도를 넘지 않도록 commit 수를 맞추도록 한다.