[NestJS] NestJS 프로젝트 첫 시작

📚 Nest.js 프로젝트를 만들고, 패키지에 대해 공부한 내용을 정리한 글입니다.

 

📣 참고 사항

 

1️⃣ node와 npm이 설치되어있는 것을 가정하고 진행합니다.

2️⃣ node 버전은 21.5.0, npm은 10.2.4버전 입니다

---

NestJS 프로젝트 시작하기

터미널에서 아래 명령어를 실행해 nest-cli를 설치합니다.

@nest/cli는 NestJS에서 제공하는 Command Line Interface이므로 -g 옵션으로 설치하여 전역에서 사용할 수 있도록 해야합니다.

npm install -g @nest/cli

 

새로운 NestJS 애플리케이션을 만드는 명령어입니다.

. 은 현재 디렉토리에 만드는 것을 의미합니다.

nest new .

 

디렉토리 경로를 입력해서 만들수도 있습니다.

nest new 디렉토리경로

그럼 어떤 패키지 매니저를 사용하겠냐고 물음이 나오는데 저는 npm으로 했습니다.

npm, yarn, pnpm 모두 상관 없습니다.

 

설치가 완료되었다면 아래 명령어를 실행해 필요한 패키지를 다운 받습니다.

npm install

아래 명령어를 실행하고 localhost:3000에 접속하면 아래와 같은 화면이 나옵니다.

npm run start

NestJS 프로젝트 디렉터리 구조

• node_modules: 프로젝트에서 사용하는 npm 패키지들이 설치되는 디렉터리입니다. 이 디렉터리는 직접 손대지 않으며, npm이나 yarn과 같은 패키지 매니저를 통해 자동으로 생성됩니다.
• src: 소스 코드가 저장되는 디렉터리입니다. 일반적으로 애플리케이션 코드 및 모듈, 컨트롤러, 서비스 등이 여기에 위치합니다.
  • src/main.ts: 애플리케이션의 진입점(entry point)입니다. 이 파일에서 NestJS 애플리케이션을 생성하고 시작하는 코드를 찾을 수 있습니다.
  • src/app.module.ts: 애플리케이션의 주 모듈입니다. 애플리케이션의 기본 설정 및 주요 구성 요소들이 여기에 정의됩니다.
• test: 테스트 파일들이 저장되는 디렉터리입니다. NestJS는 기본적으로 Jest를 사용하여 테스트를 관리합니다.
• tsconfig.json: TypeScript 컴파일러 설정 파일입니다. TypeScript 컴파일러가 어떻게 동작하고 프로젝트를 어떻게 컴파일할지에 대한 설정이 정의되어 있습니다.
• package.json 및 package-lock.json 또는 yarn.lock: 프로젝트의 의존성 및 스크립트 등이 정의된 파일들입니다.
• nest-cli.json: NestJS CLI 설정 파일로, 프로젝트에 대한 CLI 동작을 설정합니다.

 

 

---

여기서부터는 패키지를 하나하나 설치하고, 파일을 만들어서 NestJS 애플리케이션을 시작합니다!

공부하실 분들만 읽어주세요 🙏

 

 

 

NestJS 설치하기

프로젝트 디렉터리에서 아래 명령을 입력하여 의존성 패키지를 설치합니다.

cd 프로젝트디렉터리경로
npm install @nestjs/core @nestjs/common @nestjs/platform-express reflect-metadata typescript

 

NestJS 환경을 전역으로 설치하겠습니다. @nestjs/cli 는 NestJS 프레임워크에서 제공하는 Command Line Interface입니다. 

 

또 이어서 설치하는 패키지에 대해서 간략하게 설명하겠습니다.

• @nestjs/core: NestJS 애플리케이션의 기본 구조와 런타임을 제공
• @nestjs/common: NestJS에서 공통으로 사용되는 유틸리티 및 데코레이터를 제공
• @nestjs/platform-express: NestJS 애플리케이션을 익스프레스의 req, res 객체를 사용하는 라이브러리
• reflect-metadata: TypeScript와 함께 사용되는 라이브러리
• typescript: TypeScript 언어를 사용하여 NestJS 애플리케이션을 개발하기 위해 필요한 패키지

 

package.json 에 아래처럼 의존성이 추가된 것을 확인해주세요

{
  "dependencies": {
    "@nestjs/common": "^10.3.0",
    "@nestjs/core": "^10.3.0",
    "@nestjs/platform-express": "^10.3.0",
    "reflect-metadata": "^0.1.14",
    "typescript": "^5.3.3"
  }
}

 

 

 

타입스크립트 설정하기

NestJS는 타입스크립트 문법을 지원하기 때문에 타입스크립트를 사용하여 NestJS를 더욱 편리하게 개발할 수 있습니다. 

 

타입스크립트는 자바스크립트에 타입을 추가한 언어라고 생각하시면 되고, 자바스크립트로 트랜스파일되어 실행됩니다. 그렇기 떄문에 어떤식으로 타입스크립트 파일을 컴파일 할 지 설정해야 합니다.

 

프로젝트 루트에 tsconfig.json 파일을 생성하고 아래 코드를 추가하도록 합시다.

{
  "compilerOptions": {
    "module": "CommonJS",
    "target": "ESNext",
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

 

위 코드에 대해 간략하게 설명하겠습니다.

 

• module: "CommonJS": 이 옵션은 TypeScript가 모듈을 어떻게 처리할지를 지정
• target: "ESNext": TypeScript가 생성하는 JavaScript 코드가 어떤 버전을 대상으로 하는지를 나타냄
• experimentalDecorators: true: 이 옵션은 TypeScript가 실험적인 데코레이터 문법을 사용할 수 있도록 허용하는 것. 데코레이터는 클래스 및 클래스 멤버에 메타데이터를 추가하는 데 사용됨. NestJS와 같은 프레임워크에서 자주 사용.
• emitDecoratorMetadata: true: 데코레이터 메타데이터를 생성할지 여부를 나타냄. 이 옵션을 true로 설정하면, 데코레이터에 대한 메타데이터가 런타임에서 사용 가능. NestJS와 같은 프레임워크에서는 이 메타데이터를 통해 의존성 주입과 같은 기능을 구현.

 

 

 

NestJS 모듈과 컨트롤러 만들기

루트 폴더에 src 폴더를 만들고 src 안에 app.controller.ts 파일을 만들겠습니다.

import { Controller, Get } from "@nestjs/common";

@Controller()
export class HelloController {
    @Get()
    hello() {
        return "Hello NestJS"
    }
}

 

import { Controller, Get } from "@nestjs/common";

• @nestjs/common 패키지에서 Controller와 Get데코레이터를 가져옵니다.
• Controller 데코레이터는 클래스를 NestJS 컨트롤러로 선언합니다.
• Get 데코레이터는 해당 메서드가 HTTP GET 요청을 처리하는 핸들러라는 것을 나타냅니다.

@Controller()

• 클래스 HelloController에 컨트롤러 데코레이터를 적용합니다.

@Get()

• hello 메서드가 HTTP GET 요청을 처리하는 핸들러임을 선언합니다.
  
  • hello 메서드는 문자열 "Hello NestJS"를 반환합니다.

 

 

 

src 폴더 안에 app.module.ts파일을 만들고 아래 코드를 추가하겠습니다.

import { Module } from "@nestjs/common";
import { HelloController } from "./app.controller";

@Module({
    controllers: [HelloController],
})

export class HelloModule {}

import { Module } from "@nestjs/common";

• @nestjs/common 패키지에서 Module 데코레이터를 가져옵니다.
• Module 데코레이터는 NestJS 모듈을 정의할 때 사용됩니다.

import { HelloController } from "./app.controller";

• 현재 모듈에서 사용할 컨트롤러인 HelloController를 app.controller.ts 파일에서 가져옵니다.
• 컨트롤러는 해당 모듈에서 라우팅을 처리하는 역할을 합니다.

@Module({ controllers: [HelloController] })

• @Module 데코레이터를 사용하여 NestJS 모듈을 정의합니다.
• 객체 리터럴 안에 controllers 속성을 사용하여 현재 모듈에서 사용할 컨트롤러들을 배열로 전달합니다. 여기서는 HelloController를 사용하고 있습니다.

export class HelloModule {}

• HelloModule 클래스를 선언하고 외부에서 사용할 수 있도록 내보냅니다.
• 이 클래스는 NestJS 모듈을 나타내며, 해당 모듈은 HelloController를 포함하고 있습니다.

 

NestJS 애플리케이션 실행하기

src 폴더에 main.ts 파일을 생성합니다.

import { NestFactory } from "@nestjs/core";
import { HelloModule } from "./app.module";

const PORT = 3000;

// NestJS를 시작시키는 함수
async function bootstrap() {
    const app = await NestFactory.create(HelloModule);
    await app.listen(PORT, () => { console.log(`서버가 ${PORT}에서 실행 중`)})
}

bootstrap()

import { NestFactory } from "@nestjs/core"

• NestJS의 핵심 패키지인 @nestjs/core에서 NestFactory를 가져옵니다.
• NestFactory는 NestJS 애플리케이션을 생성하는 데 사용되는 팩토리 클래스입니다.

import { HelloModule } from "./app.module"

• 현재 애플리케이션에서 사용할 모듈인 HelloModule을 app.module.ts 파일에서 가져옵니다.
• 이 모듈은 앞서 설명한 것처럼 NestJS 모듈을 나타냅니다.

async function bootstrap() { ... }

• 애플리케이션을 시작하는 bootstrap 함수를 정의합니다. 이 함수는 NestJS 애플리케이션을 생성하고 포트에 바인딩하여 서버를 시작합니다.

const app = await NestFactory.create(HelloModule);

• NestFactory.create 메서드를 사용하여 HelloModule을 기반으로 하는 NestJS 애플리케이션을 생성합니다.
• 생성된 애플리케이션은 app 변수에 할당됩니다.

await app.listen(PORT, () => { console.log(서버가 ${PORT}에서 실행 중)})

• app.listen 메서드를 사용하여 애플리케이션을 지정된 포트(PORT)에서 실행합니다.
• 서버가 시작되면 콜백 함수가 호출되고, 콘솔에 서버가 어느 포트에서 실행 중인지에 대한 메시지가 출력됩니다.

bootstrap()

• bootstrap 함수를 호출하여 애플리케이션을 시작합니다. 이 함수는 비동기로 동작하므로 await 키워드를 함께 사용합니다.

 

이제 터미널에서 아래 명령어를 통해 네스트 애플리케이션을 실행합니다.

npx ts-node-dev src/main.ts

 

타입스크립트로 만든 프로그램을 바로 실행하려면 ts-node-dev 라는 패키지가 있어야 합니다. 설치하지 않고 실행하려면 설치할지 여부를 물어보는데, 이때 y를 입력하면 애플리케이션이 시작됩니다.

 

 

localhost:3000에 접속했을 때 Hello NestJS가 보이면 성공입니다!

---

다음 글에서는 NestJS의 요청 처리 순서와 API 만드는 방법에 대해 소개하겠습니다!