NestJS 환경 구성 - Part.2 NestJS 구조 분석

누군가·2024년 3월 5일
0

NestJS 환경 구성

목록 보기
2/3
  • 이전 글에서처럼 NestJS 프로젝트를 생성하면 기본적인 디렉터리 구조가 생성됩니다.
  • 이에 대해 살펴보도록 합니다.

기본 구조

  • 프로젝트를 생성하면 아래와 같은 구조가 생성됩니다.

  • node_modules
    : NestJS 프로젝트에서 사용되는 패키지들이 설치되는 디렉토리입니다.
    이 디렉토리는 주로 프로젝트의 의존성 모듈을 담고 있습니다.

  • src/
    : Typescript 소스코드가 위치하며, 해당 디렉터리 내부에 아래와 같은 파일이 위치합니다.

    • main.ts
      : 프로젝트의 애플리케이션을 실행하는 진입점으로 사용되는 파일입니다.
    • app.modules.ts
      : 애플리케이션의 기본 모듈을 정의하는 파일입니다.
    • app.controller.ts
      : HTTP 요청을 처리하는 컨트롤러 클래스입니다.
    • app.service.ts
      : 비즈니스 로직을 처리하는 서비스 클래스입니다.
    • app.controller.spec.ts
      : 애플리케이션 테스트를 위한 유닛 테스트 스펙 파일이며, 보통 특정 컨트롤러 클래스의 동작을 검증하기 위해서 테스트 케이스를 정의하고 실행하는데 사용합니다.
  • dist/
    : src/ 디렉터리 내의 Typescript로 작성된 NestJS 프로젝트가 빌드되면 생성되는 디렉터리이며, 해당 디렉터리 내에는 Typescript 코드가 Javascript로 컴파일된 결과물을 포함하고 있습니다.

  • test/
    : 테스트 파일이 위치하는 디렉터리입니다.

  • .eslintrc.js
    : 개발자들이 특정한 규칙으로 코드를 깔끔하게 작성할 수 있도록 도와주는 라이브러리입니다.
    Typescript를 사용하는 가이드라인을 제시하거나 문법에 오류가 나면 알려주는 역할을 합니다.

  • .gitignore
    : Git으로 버전 관리를 하지 않을 파일 및 디렉터리를 지정하는 파일입니다.
    해당 파일에 지정된 파일이나 디렉터리는 Git Repository에 포함되지 않습니다.

  • .prettierrc
    : 주로 코드 형식을 맞추는데 사용합니다.
    예를 들면, 어떤 따옴표를 사용할지, Indent 값을 어떻게 설정할지와 같은 코드 포멧터 역할을 합니다.

  • nest-cli.json
    : NestJS CLI를 사용하는 프로젝트를 설정하기 위한 파일입니다.
    이 파일은 주로 프로젝트의 빌드, 실행 등의 동작을 제어하는데 사용됩니다.

  • package.json
    : 프로젝트의 메타데이터와 의존성 모듈에 대한 정보를 포함하는 파일입니다.

  • tsconfig.json
    : Typescript 프로젝트를 설정하는데 사용되는 파일이며, Typescript를 빌드하거나 실행하기 위한 설정을 포함하는 파일입니다.

  • tsconfig.build.json
    : 주로 프로젝트의 Production 환경에서 애플리케이션을 빌드 할 때 사용되며, tsconfig.json 파일을 확장하는 개념이라고 생각하면 됩니다.

Reference

https://velog.io/@ksone02/NestJS-시작하기-구조

profile
개발 중에 알게된 내용을 공유합니다 (나도 기억할겸)

0개의 댓글