Home

dnd-15th-3-backend Wiki

DND 15기 3조 백엔드 팀의 개발 문서입니다.

📖 문서 목록

문서	설명
Git Flow	브랜치 전략과 PR / 머지 규칙
Commit Convention	커밋 메시지 작성 규칙
Code Convention	코드 스타일 및 네이밍 규칙
Folder Structure	NestJS 폴더 구조와 모듈 설계 규칙
Environment Variables	환경 변수 설정과 zod 검증, mise 역할 분리
Deployment	OCI k3s + ArgoCD GitOps 배포와 환경별 운영 규칙
PostGIS K3s Operations	dev PostGIS 배포, migration, 알림과 k3s 장애 복구 절차
Storage API	OCI Object Storage pre-signed URL 사용법
API and Place Sync	API 계약, 주변 장소 검색, PostGIS migration과 Worker 운영

🚀 Quick Start

# 최초 환경 세팅 (툴체인 + 의존성 설치, kubectl 포함)
mise run setup

# 환경 변수 파일 준비 (최초 1회, 값 채우기)
cp .env.example .env.development

# 개발 클러스터 접속 준비 (최초 1회)
# 1. 인프라 관리자에게 kubeconfig를 받아 ~/.kube/config 로 저장
# 2. 팀 Tailscale 네트워크 연결 (API 서버 도달 경로)

# 클러스터 접속 확인 (kubectl·kubeconfig·권한)
mise run cluster-check

# 개발 서버 실행 (dev 클러스터 DB에 port-forward 연결, watch 모드)
mise run dev-api

개발은 dev 클러스터의 PostgreSQL에 붙여서 실행합니다. DB 자격증명은 클러스터 Secret에서 자동으로 주입되므로 .env.development에 DB 값을 채울 필요가 없습니다. OCI_REGION이 비어 있어도 S3Client 초기화 에러로 부팅에 실패하므로 .env.development에 최소한 리전은 채워야 합니다. 자세한 내용은 Environment Variables를 참고하세요.