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/prod PostGIS 배포, migration, 알림과 k3s 장애 복구 절차
Storage API	OCI Object Storage pre-signed URL 사용법
API and Place Sync	API 계약, 주변 장소 검색, PostGIS migration과 Worker 운영

🚀 Quick Start

# Docker Desktop 또는 OrbStack 설치 (최초 1회)

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

# 개발 모드 시작 (로컬 DB + migration + API, 여러 번 실행해도 안전)
mise run dev

mise run dev는 Docker 확인, .env.development 자동 생성(.env.example에서 복사), 로컬 PostGIS 데이터베이스(127.0.0.1:15432) 기동, pending migration 실행, API 부팅을 순서대로 처리합니다. 클러스터 접근이 필요 없습니다. 외부 서비스 키(Kakao, Google, OCI)가 필요하면 .env.development에 채웁니다. 실데이터 디버깅이 필요할 때는 mise run cluster-check 후 mise run dev-api로 로컬 API를 dev 클러스터 DB에 붙일 수 있습니다 (kubeconfig + Tailscale 필요). 자세한 내용은 Environment Variables를 참고하세요.