Merge pull request #890 from dangdangwalk/backend/DANG-1258

backend/DANG-1258: 리드미 수정
dangdangwalk · Sep 1, 2024 · 46edb34 · 46edb34
2 parents 87afd6b + 3c322ef
commit 46edb34
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -63,7 +63,8 @@ git clone https://github.com/dangdangwalk/dangdang-walk.git
 
 환경 설정 방법은 각각 `backend`, `frontend` 폴더에 있는 `README.md` 파일에서 확인할 수 있습니다.
 
-- [Backend 환경 설정 안내](https://github.com/jihwooon/dangdang-walk/tree/main/backend#readme)
+- [Backend - 서버 환경 설정 안내](https://github.com/dangdangwalk/dangdang-walk/blob/main/backend/server/README.md)
+- [Backend - 날씨 api 모듈 환경 설정 안내](https://github.com/dangdangwalk/dangdang-walk/blob/main/backend/weather-api-module/README.md)
 - [Frontend 환경 설정 안내](https://github.com/jihwooon/dangdang-walk/tree/main/frontend#readme)
 
 # 🛠️ 기술 스택

diff --git a/backend/server/README.md b/backend/server/README.md
@@ -15,7 +15,7 @@
 
 ### 환경 설정 파일 생성
 
-`.env.{환경}` 파일을 생성하고 아래 내용을 입력합니다.
+backend/server에 `.env.local` 파일을 생성하고 아래 내용을 입력합니다.
 <br>
 각 항목의 값은 실제 발급받은 API 키 및 설정 값으로 변경해야 합니다.
 
@@ -62,7 +62,12 @@ REFRESH_TOKEN_LIFETIME=14d
 
 ※ **주의:** API 키 발급 및 환경 설정 파일 생성은 프로젝트 실행 전에 반드시 완료해야 하는 필수 절차입니다. 이 단계를 완료하지 않으면 프로젝트를 정상적으로 실행할 수 없습니다.
 
-## 1. 프로젝트 실행하기
+## 1. 의존성 설치하기
+
+-   backend/ 에서 `npm install` 명령어로 공통 의존성을 설치합니다.
+-   backend/server에서 `npm install` 명령어로 서버에 필요한 의존성을 설치합니다.
+
+## 2. 프로젝트 실행하기
 
 -   `.env.{환경}` 구성에 따라 env 파일을 생성합니다.
 -   `backend` 폴더에서 실행방법은 다음과 같습니다.

diff --git a/backend/server/package.json b/backend/server/package.json
@@ -9,7 +9,6 @@
         "build": "nest build",
         "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
         "start": "cross-env NODE_ENV=local nest start --watch",
-        "start:dev": "cross-env NODE_ENV=dev nest start --watch",
         "start:debug": "nest start --debug --watch",
         "start:prod": "cross-env NODE_ENV=prod node dist/main",
         "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",

diff --git a/backend/server/src/statistics/statistics.service.ts b/backend/server/src/statistics/statistics.service.ts
@@ -19,6 +19,7 @@ import { getOneMonthAgo, getStartAndEndOfMonth, getStartAndEndOfWeek } from '../
 import { makeSubObject } from '../utils/manipulate.util';
 
 const CACHE_TTL = 1000 * 60 * 60;
+
 @Injectable()
 export class StatisticsService {
     constructor(

diff --git a/backend/weather-api-module/README.md b/backend/weather-api-module/README.md
@@ -8,12 +8,15 @@
 
 ### 환경 설정 파일 생성
 
-`.env` 파일을 생성하고 아래 내용을 입력합니다.
+backend/weather-api-module에 `.env.local` 파일을 생성하고 아래 내용을 입력합니다.
 <br>
 
 ```shell
 WEATHER_KEY=BsF4fSEovKFk0eYc%2FUaRwNlbs9huskqBaHql1e4%2F%2BM25cyEomjKVObFYnhwqnEeLJUz7kfeNLO3zDpzxnd%2Foew%3D%3D
-PORT=6379
+SERVER_PORT=3335
+REDIS_PORT=6379
+REDIS_HOST=localhost
+CORS_ORIGIN=http://localhost:3000
 ```
 
 ### 데이터베이스 설정하기
@@ -40,5 +43,11 @@ docker build -t my-redis:7.0.15 .
 docker run -d --name my-redis-container -p 6379:6379 my-redis:7.0.15
 ```
 
-## 1. 프로그램 실행하기
+## 1. 의존성 설치하기
+
+-   backend/ 에서 `npm install` 명령어로 공통 의존성을 설치합니다.
+-   backend/weather-api-module에서 `npm install` 명령어로 날씨 api 모듈에 필요한 의존성을 설치합니다.
+
+## 2. 프로그램 실행하기
+
 weather-api-module 디렉토리에서 `npm run start` 명령어를 입력해 실행합니다.
diff --git a/backend/weather-api-module/package.json b/backend/weather-api-module/package.json
@@ -38,10 +38,10 @@
         "lint-staged": "^15.2.2",
         "prepare": "cd .. && husky backend/.husky",
         "prettier": "^3.2.5",
-        "ts-jest": "^29.1.2"
+        "ts-jest": "^29.1.2",
+        "@types/ioredis": "^5.0.0"
     },
     "dependencies": {
-        "@types/ioredis": "^5.0.0",
         "app-root-path": "^3.1.0",
         "cross-env": "^7.0.3",
         "dotenv": "^16.4.5",

diff --git a/backend/weather-api-module/src/http/xml-util.ts b/backend/weather-api-module/src/http/xml-util.ts
@@ -18,7 +18,6 @@ const parseXML = promisify(parseString);
 export async function parseErrorCode(error: string): Promise<string> {
     const errorXML: errorXML = (await parseXML(error)) as errorXML;
     const errorMsg = errorXML.OpenAPI_ServiceResponse.cmmMsgHeader[0].returnAuthMsg[0];
-    console.log(errorMsg);
     return errorMsg;
 }
 

diff --git a/backend/weather-api-module/src/init.ts b/backend/weather-api-module/src/init.ts
@@ -20,7 +20,7 @@ async function init() {
         await scheduler.initializeScheduler();
         logger.info('Scheduler가 성공적으로 실행되었습니다');
     } catch (error) {
-        console.error(`초기화 중 오류 발생. 프로세스를 종료합니다. Error:  ${error.message}`, error.stack);
+        logger.error(`초기화 중 오류 발생. 프로세스를 종료합니다. Error:  ${error.message}`, error.stack);
         process.exit(1);
     }
 }