[잡학다식] NestJS - 프로젝트 만들기

회사에서 NestJS를 사용하고 있어서 열심히 공부 중이다.

NestJS 공식문서를 참고하면서 글을 작성해 본다(간략한 순서만 정리).

---

NestJS 프로젝트 만들기

1. nestjs/cli 설치하기
2. nest project 만들기
3. module 만들기
4. controller 만들기
5. service 만들기

---

node.js가 설치되어 있다고 생각하고 진행하겠다.

 

1. nestjs/cli 설치하기

먼저 아래의 명령어로 nestjs/cli를 설치한다.

npm i -g @nestjs/cli

이미 설치되어 있었는데 다시 명령어를 실행해서 처음 설치했을때와 결과가 다른지는 모르겠다.

 

2. nest project 만들기

nest new project-name
nest new test-project

프로젝트를 생성할 폴더로 이동해서 위 명령어를 입력해주면 프로젝트가 생성된다.

project-name 에 test-project 처럼 원하는 프로젝트 이름을 써주면 된다.

 

package manager를 선택하라고 화면에 표시되는 것을 확인할 수 있다.

package manager을 본인이 잘 쓰는 것을 선택하도록 한다.

공식문서에는 npm으로 진행되는 것이 많고 나도 npm을 쓰기 때문에 npm을 선택한다.

 

package manager를 선택하면 nest project가 만들어 진 것을 확인할 수 있다.

그리고 이미지에 나와 있듯이 프로젝트 폴더로 이동하고 실행할 수 있고 실행하면 서버에 접속되는 것을 확인할 수 있다.

cd test-project
npm run start

 

3. module 만들기

공식문서의 순서는 controller -> provider -> module 순서로 되어있다.

하지만 cli를 사용해서 만들다 보니 module -> controller -> service 순서로 만들어야 module에서 자동으로 맵핑되어서 순서를 바꿨다.

nest g module cats

module을 만드는 명령어이다. cats 에 만들고 싶은 모듈 이름을 넣으면 된다.

 

4. controller 만들기

nest g controller cats
nest g co cats

controller를 만드는 명령어다. controller를 줄여서 co로 사용할 수 있다.

 

5. service 만들기

nest g service cats
nest g s cats

service도 마찬가지로 s로 줄여서 사용할 수 있다.

---

마무리

위에 순서대로 하면 cats 폴더 안에 controller, service가 만들어 진 것을 확인할 수 있다.

그리고 cats.module.ts에 controller와 service가 들어가 있는 것도 확인할 수 있다. 이것 때문에 순서를 위와 같이 정했다.

cli 명령어를 사용해서 만들어도 좋고 직접 만들어도 상관없다.

cli를 사용하면 나중에 module 폴더를 만들어 따로 정리할때 고생할 것 같은 느낌이 든다.