[Nodemon] 초보자 가이드 _ Node.js 서버개발 시 유용한 툴 (feat. 예제코드)

Nodemon?
Node.js를 사용해 개발하다 보면, 코드를 수정할 때마다 서버를 수동으로 껐다 켰다 하는 아주 귀찮은 과정을 겪게 된다.
Nodemon은 이러한 불편함을 해결해 줄 수 있는 아주 스마트한 툴로, 개발자가 소스를 수정하게 되면 똑똑한 nodemon이 파일변화를 감지하고 자동으로 서버를 재시작 해준다. 

 

 

---

 

 

🛠️  Nodemon 설치 하는 법  🛠️ 

Nodemon을 사용하려면 먼저 Node.js와 npm이 설치되어 있어야 하기 때문에 없다면 npm 설치가 우선!

(공식웹사이트에서 다운 gogo)

 

1. Node.js / npm 설치 확인

- 설치 완료 후 터미널에 아래의 명령어를 입력하고 설치가 되었는지 확인한다. 

node -v
npm -v

 

 

2. Nodemon 설치

- Nodemon은 npm을 통해 설치할 수 있다.

  아래 명령어를 터미널에 입력하여 Nodemon을 글로벌로 설치한다.

  (아래 두개 버전 중 아무거나 해도 상관없음!)

npm install -g nodemon

-g 옵션은 Nodemon을 글로벌로 설치하여 어느 프로젝트에서나 사용할 수 있게 함

 

npm install nodemon --save-dev

--save 옵션은 Nodemon을 pakage.json에 저장해 주기 위함

-dev는 로컬에서 테스트시에만 사용하겠다는 의미

(-dev를 붙이면 pakage.json파일에서 dependencies 객체가 아닌 devDependencies객체에 저장된다. 아래 이미지 참고) 

-dev를 붙이는 경우

 

 

3. Pakage.json에 명령어 추가  (생략가능)

- nodemon을 사용하기 위해 script에 명령어를 추가해준다.  ex) "dev" : "nodemon index.js" 
(위 예시의 index.js는 서버파일의 이름으로 바꾸어주기.)

 

 

---

🕹️  Nodemon 실행 방법  🕹️

Nodemon 설치가 완료 되었다면 이제 실행 할 준비가 된것!

 

1. 사용중인 프로젝트 디렉토리로 이동

- 터미널을 열고, Node.js 프로젝트가 위치한 디렉토리로 이동한다.

(cd뒤에 프로젝트가 위치한 디렉토리를 넣어주기.)

cd my-project-directory

 

 

2. Nodemon으로 서버 실행

- 서버 파일(예: app.js 또는 index.js 또는 server.js .... )을 Nodemon으로 실행한다. 

 

💡 설치시 3번(Pakage.json에 명령어 추가)을 한 경우, 아래의 명령어로
(아래의 dev 부분은 script에 추가한 명령어에 따라 변경)

npm run dev

 

💡 설치시 3번(Pakage.json에 명령어 추가)을 생략한 경우, 아래의 명령어로

(아래의 index.js 부분은 서버파일명에 따라 변경)

nodemon index.js

 

 

✅  끝!!

여기까지 했다면 서버파일을 수정할 때마다

Nodemon이 파일변화를 감지하고

자동으로 서버를 재시작 해준다! 

 

---

 

🌈  예제 코드  🌈  

아래는 Node.js 공식 웹사이트에 나와있는 서버코드 예시인데, 빠르게 따라해 보면 좋을듯!

이 코드를 서버파일에 넣고 Nodemon 실행 후 ' http://localhost:3000/ '  에서 확인해보기~

const express = require('express');
const app = express();

app.get('/', (req, res) => {
  res.send('Hello, Nodemon!');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});