프로그래밍/Nest.js

Nest.js 프로젝트 설정: Nest CLI 설치 및 프로젝트 생성 가이드

shimdh 2025. 3. 20. 14:39
728x90

Nest.js는 현대적인 Node.js 서버 사이드 애플리케이션을 구축하기 위한 강력한 프레임워크입니다. 이 블로그 포스트에서는 Nest CLI를 설치하고 새로운 Nest.js 프로젝트를 생성하는 방법에 대해 자세히 설명하겠습니다. 이를 통해 개발자는 프로젝트를 효율적으로 관리하고, 빠르게 개발 환경을 설정하여 생산성을 극대화할 수 있습니다.

1. Nest CLI란 무엇인가?

Nest CLI(Command Line Interface)는 Nest.js 애플리케이션을 쉽게 만들고 관리할 수 있도록 도와주는 유용한 도구입니다. 이 도구는 다음과 같은 다양한 기능을 제공합니다:

  • 프로젝트 생성: 기본 템플릿을 사용하여 새로운 Nest.js 프로젝트를 신속하게 시작할 수 있습니다. 이를 통해 개발자는 초기 설정에 소요되는 시간을 절약할 수 있습니다.
  • 모듈, 컨트롤러, 서비스 생성: 필요한 구성 요소들을 자동으로 생성하여 코드 작성의 일관성을 유지하고, 개발 과정에서의 오류를 줄여줍니다.
  • 애플리케이션 빌드 및 실행: 명령어 한 줄로 애플리케이션을 실행하거나 배포할 수 있어, 개발자가 복잡한 설정 없이도 쉽게 작업을 수행할 수 있습니다.

2. Nest CLI 설치

Nest CLI를 설치하기 위해서는 먼저 Node.js가 시스템에 설치되어 있어야 합니다. Node.js가 준비되었다면, 다음 단계를 따라 진행하세요:

2.1 npm을 사용한 설치

npm을 통해 Nest CLI를 설치하려면 아래의 명령어를 입력합니다:

npm install -g @nestjs/cli

위 명령어는 전역적으로 @nestjs/cli 패키지를 설치합니다. -g 플래그는 패키지를 전역으로 설치하겠다는 의미로, 이를 통해 언제 어디서나 Nest CLI를 사용할 수 있습니다.

2.2 설치 확인

설치가 완료되면, 아래의 명령어를 입력하여 현재 설치된 Nest CLI의 버전을 확인할 수 있습니다:

nest --version

이 명령어를 통해 설치가 제대로 이루어졌는지 확인할 수 있습니다.

3. 새로운 프로젝트 생성

Nest CLI가 성공적으로 설치되었다면, 이제 새로운 Nest.js 프로젝트를 생성해보겠습니다.

3.1 프로젝트 생성

아래의 명령어를 사용하여 새로운 프로젝트를 생성합니다:

nest new project-name

project-name 부분은 원하는 이름으로 변경하면 됩니다. 예를 들어, "my-nest-app"이라는 이름의 새 프로젝트를 만들려면 다음과 같이 입력합니다:

nest new my-nest-app

3.2 패키지 매니저 선택

프로젝트를 만드는 과정에서 사용할 패키지 매니저(NPM 또는 Yarn)를 선택하라는 메시지가 나타납니다.

  • NPM: 기본적으로 제공되는 패키지 매니저로 의존성 관리를 하게 됩니다.
  • Yarn: 더 빠르고 효율적인 의존성 관리를 제공받을 수 있습니다.

3.3 디렉토리 이동 및 서버 실행

아래와 같이 만들어진 디렉토리로 이동한 후 서버를 실행해봅시다:

cd my-nest-app
npm run start

이 명령어를 통해 개발 서버가 실행되며, 이제 애플리케이션을 테스트할 준비가 완료되었습니다.

3.4 서버 접근

이제 브라우저에서 http://localhost:3000에 접속하여 기본 페이지가 잘 열리는지 확인해 보세요! 이 단계에서 애플리케이션이 정상적으로 작동하는지 확인하는 것이 중요합니다.

4. 실습 예제

새로운 프로젝트를 만든 후에는 다양한 모듈과 서비스를 추가하여 기능성을 확장해야 합니다. 예시로 간단한 'Hello World' API 엔드포인트를 만들어볼 수 있습니다:

4.1 컨트롤러 추가

아래의 명령어를 입력하여 새로운 컨트롤러를 생성합니다:

nest g controller hello 

이 명령어는 hello.controller.ts 파일을 자동으로 생성합니다.

4.2 컨트롤러 내용 수정

생성된 컨트롤러 파일을 열고 아래와 같이 내용을 수정합니다:

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

@Controller('hello')
export class HelloController {
  @Get()
  getHello(): string {
    return 'Hello World!';
  }
}

이 코드는 /hello 경로로 GET 요청이 들어올 때 "Hello World!"라는 문자열을 반환하는 간단한 API 엔드포인트를 정의합니다.

4.3 브라우저에서 /hello 경로에 접속하여 결과 확인하기

이제 브라우저에서 /hello 경로에 접속하여 결과를 확인해보세요. "Hello World!"라는 메시지가 잘 출력되는지 확인하는 것이 중요합니다.

결론

이렇게 간단히 프로젝트 설정부터 시작해서 실제 API 엔드포인트까지 구현하는 과정을 경험함으로써 실력을 키울 수 있습니다! Nest CLI를 활용하여 효율적인 개발 환경을 구축하고, 다양한 기능을 추가해 나가며 더 나은 애플리케이션을 만들어 보세요. 이상으로 Nest CLI를 활용한 프로젝트 설정 및 생성에 대한 개요였습니다!

728x90