Node.js 초기세팅 가이드

1.프로젝트 폴더 생성

• 새로운 디렉토리를 만들고, 프로젝트의 이름으로 폴더를 명명합니다.

2.package.json 파일 생성

• 프로젝트 폴더에서 터미널 또는 명령 프롬프트를 열고 다음 명령을 실행하여 package.json 파일을 생성합니다.

npm init -y

 

3.node_modules 폴더 생성

• 프로젝트 폴더에서 다음 명령을 사용하여 필요한 패키지를 설치하고 node_modules 폴더를 생성합니다.

npm install

 

 

4. .gitignore 설정

•  프로젝트 폴더 내에 .gitignore 파일을 생성합니다 https://www.toptal.com/developers/gitignore 사이트에 접속하여 필요한 설정을 추가하여 .gitignore 파일을 생성합니다. 이 사이트는 다양한 환경 및 언어에 대한 .gitignore 파일을 자동으로 생성해줍니다.
• vim, macOS, node, linux, visualStudioCode, dotenv 등 생성

.gitignore

# Ignore node_modules
node_modules/

# Ignore .env 파일 (환경 변수 파일)
.env

# Ignore dbmate schema 파일과 CSV 파일
schema.sql
*.csv

# Ignore macOS 관련 파일
.DS_Store

//예시입니다

5.express 설치

• 필요한 패키지를 npm을 사용하여 설치합니다. 예를 들어, Express.js를 설치하려면 다음과 같이 실행합니다.

npm install express

 

6.nodemon 설치

• 코드를 수정할 때 자동으로 서버를 다시 시작해주는 nodemon을 설치합니다.

npm install nodemon

7.package.json에 start 스크립트 추가

• package.json 파일 내에서 "scripts" 섹션에 다음과 같이 "start" 스크립트를 추가합니다.

"scripts": {
  "start": "nodemon app.js"
}

 

8.필요한 패키지 설치

• 프로젝트에 필요한 패키지를 설치합니다. 이때, package.json 파일에 의존성 패키지가 정확히 추가되는지 확인합니다. 필요한 패키지는 다음과 같습니다:

Dependencies:

• express
• mysql2 (또는 mysql1)
• typeorm
• cors
• bcrypt
• jsonwebtoken
• dotenv

DevDependencies:

• nodemon
• morgan

 

9.app.js 서버 코드 작성

• app.js 파일을 생성하고 Express.js를 사용하여 서버 코드를 작성합니다. CORS와 .env 파일도 설정합니다.

// app.js
require("dotenv").config();
// 환경 변수 로드

const express = require("express");
const cors = require("cors");
const morgan = require("morgan");

const app = express();
app.use(cors());
app.use(express.json());
app.use(morgan("combined"));

app.get("/ping", (req, res, next) => {
  res.status(200).json({ message: "pong" });
});

const startServer = async () => {
  const PORT = process.env.PORT || 3000;

  app.listen(PORT, () => {
    console.log(`Listening on Port ${PORT}`);
  });
};

startServer();

 

 

10.CORS 설치

• CORS 미들웨어를 설치하고 모든 요청에 대한 CORS 정책을 설정합니다.

npm install cors

 

 

11.dotenv 환경 변수 설정

• env 파일을 생성하고 환경 변수를 관리합니다. 필요한 환경 변수를 .env 파일에 추가하고, 코드에서 dotenv를 사용하여 불러옵니다.

// .env
DB_HOST=localhost
DB_PORT=3306
DB_USER=root
DB_PASSWORD=password
DB_DATABASE=mydatabase
PORT=3000
SECRET_KEY=mysecretkey

12.Morgan 설치

• 로깅을 위한 morgan 미들웨어를 설치하고, Express 애플리케이션에 적용합니다.

13.dbmate 설정

• ERD에 기반한 전체 table을 생성하는 migrations 파일 생성
• dbmate up 명령어를 이용한 mysql database 내 파일 생성 확인
• schema 파일이 Github 상에 공유가 되지 않았는지 확인

14. Runserver 구동 Test 

• npm start 했을 때, 콘솔 패널에 에러 메시지 없이 잘 실행 되는지 확인 (에러가 있다면 해결 할 것)

 

14.서버 실행

• 터미널에서 프로젝트 폴더에서 다음 명령으로 서버를 실행합니다.

npm start

 

이렇게 하면 Node.js 프로젝트를 초기화하고 설정할 수 있습니다. 필요한 패키지와 환경 변수를 추가하고, Express.js를 사용하여 서버를 작성할 수 있습니다. 문제가 있는 부분을 수정했으며, 원하는 대로 프로젝트를 확장하실 수 있습니다.