Skip to content

Commit 176e666

Browse files
committed
feature: readme 에 상세 내용 추가
1 parent edf8c7c commit 176e666

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.md

+20-14
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Velog Dashboard Project
22

33
- Velog dashboard V2 백엔드, API 서버
4-
- ***`node 20+`***
4+
- **_`node 20+`_**
55

66
## Project Setup Guide
77

@@ -30,6 +30,12 @@ cp .env.sample .env
3030
pnpm dev
3131
```
3232

33+
4. 로컬 테스팅을 위해서 `post.repo.integration.test` 를 필수 참조해주세요.
34+
35+
- 해당 테스트는 mocking 없이 DBMS connection 을 맺고 repo 계층의 실제 수행을 테스트 합니다.
36+
- 이에 따라, local DBMS 와 connection 을 맺는다면 **_테스트로 제공해야 할 TEST CASE 의 값들이 달라져야 합니다._**
37+
- 이 때문에 전체 테스트에 이슈가 있을 수 있으니 해당 값 꼭 체크 해주세요.
38+
3339
## 실행 가능한 명령어
3440

3541
```bash
@@ -46,17 +52,17 @@ pnpm start # 빌드된 프로젝트 시작
4652

4753
```bash
4854
├── src/
49-
├── __test__/ # 테스트 파일
50-
├── configs/ # 설정 파일 (DB 등)
51-
├── constants/ # 상수 데이터 파일
52-
├── controllers/ # API 컨트롤러
53-
├── exception/ # 커스텀 에러 파일
54-
├── middlewares/ # 각종 미들웨어 (인증, 에러, 데이터 검증 등)
55-
├── modules/ # 모듈 파일 (슬랙 등)
56-
├── repositories/ # 데이터 액세스 레이어
57-
├── routers/ # API 라우트 정의
58-
├── services/ # 비즈니스 로직
59-
├┬── types/ # Enum, DTO 등 데이터 타입 정의
60-
── models/ # 데이터 모델
61-
└── utils/ # 편의성 함수 정의
55+
│   ├── __test__/ # 테스트 파일
56+
│   ├── configs/ # 설정 파일 (DB 등)
57+
│   ├── constants/ # 상수 데이터 파일
58+
│   ├── controllers/ # API 컨트롤러
59+
│   ├── exception/ # 커스텀 에러 파일
60+
│   ├── middlewares/ # 각종 미들웨어 (인증, 에러, 데이터 검증 등)
61+
│   ├── modules/ # 모듈 파일 (슬랙 등)
62+
│   ├── repositories/ # 데이터 액세스 레이어
63+
│   ├── routers/ # API 라우트 정의
64+
│   ├── services/ # 비즈니스 로직
65+
│   ├── types/ # Enum, DTO 등 데이터 타입 정의
66+
   │   ├── models/ # 데이터 모델
67+
│   └── utils/ # 편의성 함수 정의
6268
```

0 commit comments

Comments
 (0)