첫 단계

이 글들을 통해 Nest의 핵심 기본 사항을 배우게 됩니다. Nest 애플리케이션의 필수 구성 요소에 익숙해지기 위해, 입문 수준에서 많은 부분을 다루는 기능을 갖춘 기본적인 CRUD 애플리케이션을 구축할 것입니다.

언어#

우리는 TypeScript를 좋아하지만, 무엇보다 - 우리는 Node.js를 사랑합니다. 그렇기 때문에 Nest는 TypeScript와 순수 JavaScript 모두와 호환됩니다. Nest는 최신 언어 기능을 활용하므로, 바닐라 JavaScript와 함께 사용하려면 Babel 컴파일러가 필요합니다.

우리가 제공하는 예제에서는 대부분 TypeScript를 사용하지만, 언제든지 코드 스니펫을 바닐라 JavaScript 구문으로 전환할 수 있습니다 (각 스니펫의 오른쪽 상단에 있는 언어 버튼을 클릭하여 토글하면 됩니다).

사전 요구 사항#

Node.js(버전 >= 20)가 운영 체제에 설치되어 있는지 확인하십시오.

설정#

새 프로젝트 설정은 Nest CLI를 사용하면 매우 간단합니다. npm이 설치되어 있다면, OS 터미널에서 다음 명령어를 사용하여 새 Nest 프로젝트를 생성할 수 있습니다:

$ npm i -g @nestjs/cli
$ nest new project-name

힌트 TypeScript의 더 엄격한 기능 세트로 새 프로젝트를 생성하려면, nest new 명령어에 --strict 플래그를 전달하십시오.

project-name 디렉터리가 생성되고, node 모듈 및 몇 가지 다른 기본 파일이 설치되며, src/ 디렉터리가 생성되고 몇 가지 핵심 파일로 채워집니다.

다음은 이 핵심 파일들에 대한 간략한 개요입니다:

main.ts는 애플리케이션을 부트스트랩할 비동기 함수를 포함합니다:

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(process.env.PORT ?? 3000);
}
bootstrap();

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(process.env.PORT ?? 3000);
}
bootstrap();

Nest 애플리케이션 인스턴스를 생성하기 위해 코어 NestFactory 클래스를 사용합니다. NestFactory는 애플리케이션 인스턴스를 생성할 수 있는 몇 가지 정적 메서드를 노출합니다. create() 메서드는 INestApplication 인터페이스를 만족하는 애플리케이션 객체를 반환합니다. 이 객체는 다음 장에서 설명할 메서드 집합을 제공합니다. 위의 main.ts 예제에서는 애플리케이션이 들어오는 HTTP 요청을 기다릴 수 있도록 HTTP 리스너를 간단히 시작합니다.

Nest CLI로 스캐폴딩된 프로젝트는 각 모듈을 자체 전용 디렉터리에 유지하는 규칙을 따르도록 권장하는 초기 프로젝트 구조를 생성한다는 점에 유의하십시오.

힌트 기본적으로 애플리케이션 생성 중 오류가 발생하면 앱은 코드 1로 종료됩니다. 대신 오류를 발생시키려면 옵션 abortOnError를 비활성화하십시오 (예: NestFactory.create(AppModule, { abortOnError: false })).

플랫폼#

Nest는 플랫폼 독립적인 프레임워크가 되려고 합니다. 플랫폼 독립성을 통해 개발자들이 여러 다른 유형의 애플리케이션에서 활용할 수 있는 재사용 가능한 논리적 부분을 생성할 수 있습니다. 기술적으로 Nest는 어댑터가 생성되면 모든 Node HTTP 프레임워크와 함께 작동할 수 있습니다. 두 가지 HTTP 플랫폼이 기본적으로 지원됩니다: express 및 fastify. 필요에 가장 잘 맞는 플랫폼을 선택할 수 있습니다.

어떤 플랫폼이 사용되든, 자체 애플리케이션 인터페이스를 노출합니다. 이들은 각각 NestExpressApplication 및 NestFastifyApplication으로 보입니다.

아래 예제와 같이 NestFactory.create() 메서드에 타입을 전달하면, app 객체는 해당 특정 플랫폼에 대해서만 사용할 수 있는 메서드를 갖게 됩니다. 하지만, 실제 기본 플랫폼 API에 액세스하려는 경우가 아니라면 타입을 지정할 필요는 없습니다.

const app = await NestFactory.create<NestExpressApplication>(AppModule);

애플리케이션 실행#

설치 프로세스가 완료되면, OS 명령 프롬프트에서 다음 명령어를 실행하여 들어오는 HTTP 요청을 수신하도록 애플리케이션을 시작할 수 있습니다:

$ npm run start

힌트 개발 프로세스를 가속화하려면 (빌드 속도 20배 향상), start 스크립트에 -b swc 플래그를 전달하여 SWC 빌더를 사용할 수 있습니다. 예를 들어 npm run start -- -b swc와 같이 사용합니다.

이 명령어는 src/main.ts 파일에 정의된 포트에서 HTTP 서버를 수신 대기 상태로 애플리케이션을 시작합니다. 애플리케이션이 실행되면 브라우저를 열고 http://localhost:3000/으로 이동하십시오. Hello World! 메시지가 표시되어야 합니다.

파일 변경 사항을 감시하려면, 다음 명령어를 실행하여 애플리케이션을 시작할 수 있습니다:

$ npm run start:dev

이 명령어는 파일을 감시하고, 자동으로 다시 컴파일하며 서버를 다시 로드합니다.

Linting 및 Formatting#

CLI는 대규모로 신뢰할 수 있는 개발 워크플로우를 스캐폴딩하기 위해 최선을 다합니다. 따라서 생성된 Nest 프로젝트에는 코드 린터 및 포맷터가 미리 설치되어 있습니다 (각각 eslint 및 prettier).

힌트 포맷터와 린터의 역할이 확실하지 않으신가요? 여기에서 차이점을 알아보세요.

최대 안정성과 확장성을 보장하기 위해 기본 eslint 및 prettier cli 패키지를 사용합니다. 이 설정은 공식 확장 프로그램을 통한 깔끔한 IDE 통합을 기본적으로 지원합니다.

IDE가 관련 없는 무인 환경(지속적 통합, Git Hooks 등)의 경우, Nest 프로젝트는 바로 사용할 수 있는 npm 스크립트를 제공합니다.

# eslint로 Lint 및 자동 수정
$ npm run lint

# prettier로 포맷팅
$ npm run format