NestJS/NestJS 문서화
NestJS 프로젝트 기본 구조
남느
2025. 4. 14. 17:56
CLI로 프로젝트를 생성하면 프로젝트에 필요한 패키지와 함께 프로젝트의 기본 구조도 같이 생성된다.
루트 폴더
프로젝트 루트 폴더에 있는 파일들은 설정 파일들이다.
- .gitignore : git 연동 시 무시하는 파일 및 폴더 규칙을 관리하는 파일
- .prettierrc : 코드를 정리해주는 prettier라는 라이브러리의 설정 파일
- .eslintrc.config.js : 코드 규칙을 강제하는 ESLint라는 라이브러리의 설정 파일
- nest-cli.json : NestJS 프로젝트의 구성을 관리하는 파일
- package.json : 프로젝트에서 사용하는 라이브러리들과 명령어를 관리하는 파일
- README.md : 프로젝트의 정보를 설명하는 파일
- tsconfig.build.json : 프로젝트 배포를 위한 빌드 시 제외해야 하는 폴더와 파일들을 관리하는 파일
- tsconfig.json : 프로젝트에서 타입스크립트 사용 시 어떤 규칙을 사용할 것인지 설정하는 파일
src 폴더
실제 소스 코드들은 src 폴더에 들어있다.
- main.ts : 최상위 모듈인 AppModule을 실행시키는 파일
- app.controller.spec.ts : AppModule의 단위 테스트를 위한 파일
- app.controller.ts : AppModule의 라우팅을 담당하는 파일
- app.module.ts : AppModule의 구성 요소를 명시하는 파일
- app.service.ts : AppModule의 비즈니스 로직이 들어있는 파일
test 폴더
- app.e2e-spec.ts : End to End 테스트를 하기 위한 파일
- jest-e2e.json :End to End 테스트의 설정을 담당하는 파일