OMS Monorepo Workspace (mesapphub)

본 프로젝트는 mesapphub를 비롯한 여러 도메인의 서비스(OMS API, Intos 앱 등)를 단일 코드베이스에서 우수하고 일관된 품질로 관리하기 위해 구축된 NestJS 모노레포(Monorepo) 백엔드 생태계입니다.

---

📖 프로젝트 개요 (Project Overview)

본 워크스페이스는 도메인 간의 코드 중복을 최소화하고 확장성을 극대화하기 위해 다음과 같이 **다중 앱(Apps)**과 **공유 라이브러리(Libs)**로 구성되어 있습니다.

🏢 구성 애플리케이션 (Apps)

각 애플리케이션은 서로 다른 포트를 통해 독립적으로 실행 및 배포될 수 있습니다.

• mesapphub (Port: 5107) : 사내 내부 관리 시스템을 위한 전용 백엔드 API 서비스.
• oms-api (Port: 5108) : Order Management System(OMS)을 외부 파트너/고객에게 제공하기 위한 API 서비스.
• intos-api (Port: 5109) : Intos 모바일 어플리케이션 등의 클라이언트와 통신하기 위한 B2C/B2B 앱 전용 API 서비스.

🛠️ 공유 라이브러리 (Libraries)

• @app/shared-core : 애플리케이션들이 공통으로 사용하는 핵심 기능들을 모아둔 중앙 라이브러리입니다. TypeORM 데이터베이스 연결 상태, Winston 로거, @nestjs/config 기반의 환경변수 처리기, 그리고 전역 파이프 및 보안(Helmet, CORS 등) 설정과 커스텀 예외 포맷팅(Filter) 모듈 등이 이곳에서 한 번에 통제됩니다.

---

📚 프로젝트 정책 및 아키텍처 가이드 (DOCS)

본 프로젝트의 아키텍처 규칙과 개발 환경 설정은 DOCS/ 폴더 내에 잘 정리되어 있습니다. 개발 전에 반드시 아래의 문서를 확인해 주세요!

1. 06. 로컬 환경 및 도커(회사망 분리) 데이터베이스 설정 가이드 🌟 (Updated!)
2. 02. 모노레포 아키텍처 설계 배경 및 구조
3. 03. 계층형 아키텍처 (Layered Architecture)
4. 04. Swagger API 자동화 연동
5. 05. 중앙 집중식 Winston 로깅 체계
6. 06. 로컬 및 운영 환경 변수 자동 분기 (@nestjs/config)

---

🚀 빠른 시작 가이드 (Quick Start)

본 프로젝트는 회사망(도커 실행 불가)과 개인 로컬망(도커 실행)을 원활하게 분리하여 동작하도록 설계되었습니다.

1. 패키지 설치

npm install

2. 서버 실행하기 (선택)

✅ 시나리오 A: 회사에서 작업할 때 (도커 없음)

# 순수하게 NestJS 서버만 구동 (DB는 회사의 테스트/사내 로컬 DB를 바라봅니다)
npm run start:dev

✅ 시나리오 B: 개인망에서 작업할 때 (도커 DB 필요)

# PostgreSQL 도커 컨테이너를 함께 구동시키고 NestJS를 켭니다. 
# 구동 중 터미널에서 Ctrl + C를 누르면 깨끗하게 한 번에 같이 종료됩니다.
npm run start:dev:docker

---

본 README는 기본적인 NestJS Starter 템플릿에서 mesapphub 프로젝트 전용 안내문으로 업데이트 되었습니다.