도를 깎자

서비스 소개

‘도를 깎자’는 빠르게 흘러가는 일상 속에서 자아성찰을 할 시간이 없다는 문제를 해결하고 자신의 마음을 돌아볼 수 있는 질문에 답변하고 돌을 깎음으로써, 마음의 평온을 찾고 싶어 하는 사람들에게 유익하다.

개발자 소개

정준서	백은서
sunseo18	eunseo5343

API 명세서와 역할 분배 (각자 개발 담당 부분)

기능	HttpMethod	이름	url
오늘의 돌 조회하기	GET	@정준서	{{baseUrl}}/api/stones/today
답변 입력하기	PATCH	@정준서	{{baseUrl}}/api/stones/today
모은 돌 전체보기	GET	@백은서	{{baseUrl}}/api/stones
모은 돌 상세보기	GET	@백은서	{{baseUrl}}/api/stones/:stoneId

브랜치 네이밍

feature/${이슈번호}

커밋 컨벤션

👼🏻 **git commit message convention**

ex) [FEAT] 식재료 관련 API 구현 #1

ex) [FIX] 버그 수정 #2

- [CHORE]: 코드 수정, 내부 파일 수정
- [FEAT] : 새로운 기능 구현
- [ADD] : FEAT 이외의 부수적인 코드 추가, 라이브러리 추가, 새로운 파일 생성 시
- [FIX] : 버그, 오류 해결
- [DEL] : 쓸모없는 코드 삭제
- [DOCS] : README나 WIKI 등의 문서 개정
- [MOVE] : 프로젝트 내 파일이나 코드의 이동
- [RENAME] : 파일 이름의 변경
- [MERGE]: 다른브렌치를 merge하는 경우
- [STYLE] : 코드가 아닌 스타일 변경을 하는 경우
- [REFACTOR] : 로직은 변경 없는 클린 코드를 위한 코드 수정

💡 **커밋 메세지 마지막에 이슈 번호 꼭 붙이기** ❗❗

코드 컨벤션

1. 컨트롤러 메서드명

   1. GET PATCH PUT POST DELETE로 시작하기!

   2. ex) 오늘의 돌 조회하기: getTodayStone()

      전체 모은 돌 조회하기: getStones()

      돌 정보 상세 조회하기: getStone()

2. url

   URL은 RESTful API 설계 가이드에 따라 작성합니다.

   HTTP Method로 구분할 수 있는 get, put 등의 행위는 url에 표현하지 않습니다.

   마지막에 / 를 포함하지 않습니다.

   /api로 시작합니다

   _ 대신 -를 사용합니다.

   소문자를 사용합니다.

   확장자는 포함하지 않습니다.

   복수형을 사용합니다

   ex) /api/stones /api/stones/:stoneId

3. 네이밍

   ❗ ***컨플릭트 예방을 위해서 Controller, Service 명에 이름을 포함합니다

   ex) EunseoStoneController, JunseoStoneController**

   dto 파일 명은 다음으로 통일합니다

   (Simple) + [동작] + [엔티티명] + [Response/Request] + Dto

   - 클래스 : **PascalCase,** and·or와 같은 접속사를 사용하지 않고 25자 내외로 작성합니다.
   - 함수 : **camelCase**
   - 변수: **camelCase**
   - DB 테이블: **snake_case**
   - ENUM, 상수: **PascalCase**
   - 컬렉션(Collection): **복수형**을 사용하거나 **컬렉션을 명시합니다**. (Ex. userList, users, userMap)
   - LocalDateTime: 접미사에 **Date 혹은 At**를 붙입니다.
   

프로젝트 폴더링

🗂️ project
|
|_  🗂️ common
|    |_ 🗂️ exception
|
|_  🗂️ config
|
|_  🗂️ domain
|
|_  🗂️ stone
    |
    |_  🗂️ controller
        |
        |_  🗂️ dto

ERD