JongHoon

.gitmessage.txt

@@ -0,0 +1,9 @@
+################
+# feat : 새로운 기능 추가
+# fix : 버그 수정
+# docs : 문서 수정
+# test : 테스트 코드 추가
+# refact : 코드 리팩토링
+# style : 코드 의미에 영향을 주지 않는 변경사항
+# chore : 빌드 부분 혹은 패키지 매니저 수정사항
+################

.prettierrc

@@ -1,4 +1,6 @@
 {
-  "singleQuote": true,
-  "trailingComma": "all"
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true
 }

README.md

@@ -1,4 +1,5 @@
 # 미션 - 휴대폰 인증 API
+
 ## 🔍 진행 방식
 
 - 미션은 **기능 요구 사항, 프로그래밍 요구 사항, 과제 진행 요구 사항** 세 가지로 구성되어 있다.
@@ -24,48 +25,55 @@ Ran all test suites.
 기본적으로 휴대전화 번호 인증을 위한 API를 구현한다.
 
 예시)
+
 1. 010-1234-5678로 인증번호를 전송한다.
 2. 010-1234-5678로 전송된 인증번호를 입력하면 인증이 완료된다.
 
 총 2개의 API 엔드포인트로 구성한다.
-  - 휴대전화 번호를 인증번호를 전송하는 API
-      - 실제 휴대전화 번호로 전송되는 것이 아니라, 휴대전화 번호를 입력하면 인증번호가 전송된다고 가정한다.
-      - 인증번호은 인증 요청시간으로부터 5분간 유효하다고 가정한다.
-      - 인증번호 전송시에는 API 응답으로 인증번호를 리턴한다.
-
 
-  - 휴대전화 번호와 인증번호를 입력받아 인증하는 API
+- 휴대전화 번호를 인증번호를 전송하는 API
 
+  - 실제 휴대전화 번호로 전송되는 것이 아니라, 휴대전화 번호를 입력하면 인증번호가 전송된다고 가정한다.
+  - 인증번호은 인증 요청시간으로부터 5분간 유효하다고 가정한다.
+  - 인증번호 전송시에는 API 응답으로 인증번호를 리턴한다.
+
+- 휴대전화 번호와 인증번호를 입력받아 인증하는 API
 
 ### 공통 필수 예외처리 사항
 
 - API에 요청받은 Body 값의 타입을 검증하여 올바르지 않은 타입일 경우 `400 BadRequest` 에러를 리턴해야한다.
 - API에 요청받은 Body 값의 필수 값이 누락되거나/빈 값인 경우 `400 BadRequest` 에러를 리턴해야한다.
 
-
 ### API 요청/응답 요구 사항
+
 1. 모든 API의 요청/응답은 DTO를 통해 TypeSafe하게 이루어져야한다.
 2. DTO의 타입은 `class-validator`를 이용하여 검증한다.
 3. DTO 내부 요소의 명칭은 `camelCase`로 작성한다.
 
 #### 요청
 
 - 휴대전화 번호는 010-1234-5678과 같은 문자열 형식이다.
+
 ```
 phoneNumber : 010-1234-5678
 ```
+
 - 인증번호는 6자리 랜덤 숫자 문자열이다.
+
 ```
 code : 612131
 ```
 
 #### 응답
 
 - 인증번호 요청시 인증번호를 응답으로 리턴한다.
+
 ```
 code : 612131
 ```
+
 - 인증 완료시 `true`를 응답으로 리턴한다.
+
 ```
 result : true
 ```
@@ -80,11 +88,11 @@ result : true
 - **eslint**, **prettier** 등의 코드 포맷팅 라이브러리를 이용하여 제공된 코드 컨벤션에 맞추어 코드를 작성한다.
 - `node`, `npm` 버전은 `package.json`에 명시된 버전을 사용한다. [Volta를 이용하여 node 버전을 관리한다.](https://docs.volta.sh/guide/getting-started)
 
-
 - **(선택 사항)** API 구현이 완료되고, 유닛 테스트, E2E 테스트등 모든 테스트 코드를 작성하여 테스트를 통과하면 굿!
+
 ---
 
 ## ✏️ 과제 진행 요구 사항
 
 - 미션은 [nest-phone-verify](https://github.com/eojjeoda-nest/nest-phone-verify-1) 저장소를 Fork & Clone 하고 시작한다.
-- **기능을 구현하기 전 `README.md`에 구현할 기능/예외처리를 목록으로 정리**해 추가한다.
+- **기능을 구현하기 전 `README.md`에 구현할 기능/예외처리를 목록으로 정리**해 추가한다.

docker-compose.yml

@@ -21,4 +21,4 @@ services:
     ports:
       - '3306:3306'
     volumes:
-      - db_vol:/var/lib/mysql
+      - db_vol:/var/lib/mysql

package.json

@@ -24,7 +24,7 @@
     "@nestjs/config": "^3.1.1",
     "@nestjs/core": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
-    "@nestjs/swagger": "^7.1.13",
+    "@nestjs/swagger": "^7.1.16",
     "@nestjs/typeorm": "^10.0.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",