프로젝트 개요

청약플래닛 문서

📚 문서 개요

이 문서는 청약플래닛 한국 부동산 플랫폼에서 개발팀 협업을 위한 포괄적인 정보를 제공합니다.

📁 문서 구조

핵심 문서

• 데이터베이스 명세 - 완전한 데이터베이스 스키마 및 테이블 명세
• 기능 문서 - 상세 기능 설명 및 요구 사항
• 버전 히스토리 - 릴리스 노트 및 변경 로그
• API 문서 - REST API 엔드포인트 및 명세

개발 가이드

• 아키텍처 결정 - 시스템 설계 결정 및 근거
• 배포 가이드 - 환경 설정 및 배포 절차
• 기여 가이드라인 - 코드 표준 및 기여 워크플로우
• 테스팅 가이드 - 테스팅 전략 및 모범 사례 (업데이트됨)

참조 자료

• 에러 코드 - 완전한 에러 코드 참조
• 한국 비즈니스 규칙 - 부동산 도메인 지식
• 외부 API - 서드파티 통합 문서
• 뉴스 설정 가이드 - 뉴스 크롤링 기능 설정

🚀 신규 팀원을 위한 빠른 시작

1. 도메인 이해: 한국 비즈니스 규칙부터 시작하세요.
2. 아키텍처 개요: 아키텍처 결정을 검토하세요.
3. 데이터베이스 스키마: 데이터베이스 명세를 학습하세요.
4. API 사용: API 문서를 참조하세요.
5. 개발 환경 설정: 배포 가이드를 따르세요.
6. 기여: 기여 가이드라인을 읽으세요.

📝 문서 유지보수

• 업데이트 빈도: 문서는 모든 기능 릴리스와 함께 업데이트되어야 합니다.
• 검토 프로세스: 모든 문서 변경 사항은 팀 검토가 필요합니다.
• 버전 관리: 문서는 코드와 동일한 브랜칭 전략을 따릅니다.
• 표준: 비즈니스 도메인 개념에 한국어 용어를 사용합니다.

🔗 관련 자료

• 메인 README: ../README.md - 프로젝트 개요 및 설정
• CLAUDE.md: ../CLAUDE.md - AI 도우미 지침
• API 참조: 애플리케이션 실행 시 /swagger-ui에서 사용 가능
• 테스트 커버리지: 테스트 실행 후 ../htmlReport/index.html에서 보고서 확인

---

최종 업데이트: 2025-06-26

관리자: 청약플래닛 개발팀