1e7155b864
## 🚨 보안 강화 - 하드코딩된 비밀번호를 환경변수로 전환 - .env.example 생성 및 보안 가이드 추가 - docker-compose.yml 환경변수 적용 - README.md에서 실제 비밀번호 제거 ## 🗑️ 중복 제거 - synology_deployment/ 디렉토리 제거 (268MB) - synology_deployment*.tar.gz 아카이브 제거 (234MB) - 총 502MB의 중복 파일 삭제 ## 🧹 백업 파일 정리 - *.backup 파일 제거 (10개) - *복사본* 파일 제거 - *이전* 파일 제거 - json(백업)/ 디렉토리 제거 ## 📋 .gitignore 업데이트 - 백업 파일 패턴 추가 - 보안 파일 제외 (.env, *.pem, *.key) - 임시 파일 제외 (*.tmp, *.new) - 빌드 아티팩트 제외 (*.tar.gz) ## 📚 문서화 - docs/ 디렉토리 구조 생성 - 리팩토링 분석 및 계획 문서 작성 - 코딩 스타일 가이드 작성 - 개발 환경 설정 가이드 작성 - 시스템 아키텍처 문서 작성 ## 변경된 파일 - .env.example (신규) - .gitignore (업데이트) - docker-compose.yml (환경변수 적용) - README.md (보안 정보 제거) - docs/* (신규 문서 7개) ## 보안 개선 효과 ✅ 비밀번호 노출 위험 제거 ✅ Git 히스토리에서 민감 정보 분리 ✅ 환경별 설정 분리 가능 ✅ 배포 보안 강화 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
90 lines
3.5 KiB
Markdown
90 lines
3.5 KiB
Markdown
# TK-FB-Project 개발 문서
|
|
|
|
## 📚 문서 구조
|
|
|
|
이 디렉토리는 TK-FB-Project의 개발 및 유지보수를 위한 종합 문서 저장소입니다.
|
|
|
|
### 디렉토리 구조
|
|
|
|
```
|
|
docs/
|
|
├── README.md # 이 파일 - 문서 인덱스
|
|
├── architecture/ # 아키텍처 관련 문서
|
|
│ ├── OVERVIEW.md # 시스템 아키텍처 개요
|
|
│ ├── DATABASE.md # 데이터베이스 스키마 및 설계
|
|
│ └── API_DESIGN.md # API 설계 원칙
|
|
├── refactoring/ # 리팩토링 관련 문서
|
|
│ ├── PLAN.md # 리팩토링 계획 및 로드맵
|
|
│ ├── LOG.md # 리팩토링 작업 로그
|
|
│ └── ANALYSIS.md # 코드 분석 리포트
|
|
├── guides/ # 개발 가이드
|
|
│ ├── SETUP.md # 개발 환경 설정
|
|
│ ├── CODING_STYLE.md # 코딩 스타일 가이드
|
|
│ ├── GIT_WORKFLOW.md # Git 워크플로우
|
|
│ ├── SECURITY.md # 보안 가이드라인
|
|
│ └── TROUBLESHOOTING.md # 문제 해결 가이드
|
|
└── api/ # API 문서
|
|
├── ENDPOINTS.md # API 엔드포인트 목록
|
|
├── AUTHENTICATION.md # 인증 및 권한
|
|
└── EXAMPLES.md # API 사용 예제
|
|
```
|
|
|
|
## 📖 주요 문서
|
|
|
|
### 시작하기
|
|
- [개발 환경 설정](guides/SETUP.md) - 프로젝트 설정 및 실행 방법
|
|
- [시스템 아키텍처](architecture/OVERVIEW.md) - 전체 시스템 구조 이해
|
|
- [코딩 스타일 가이드](guides/CODING_STYLE.md) - 코드 작성 규칙
|
|
|
|
### 개발
|
|
- [API 문서](api/ENDPOINTS.md) - REST API 엔드포인트 레퍼런스
|
|
- [데이터베이스 스키마](architecture/DATABASE.md) - DB 구조 및 관계
|
|
- [문제 해결](guides/TROUBLESHOOTING.md) - 자주 발생하는 문제 해결법
|
|
|
|
### 리팩토링
|
|
- [리팩토링 계획](refactoring/PLAN.md) - 개선 로드맵
|
|
- [리팩토링 로그](refactoring/LOG.md) - 변경 이력
|
|
- [코드 분석](refactoring/ANALYSIS.md) - 현재 코드베이스 분석
|
|
|
|
## 🔄 문서 업데이트 규칙
|
|
|
|
1. **리팩토링 시**: 변경 사항을 `refactoring/LOG.md`에 기록
|
|
2. **API 변경 시**: `api/ENDPOINTS.md` 업데이트
|
|
3. **아키텍처 변경 시**: 관련 다이어그램 및 문서 갱신
|
|
4. **새로운 기능 추가 시**: 해당 가이드 문서 작성
|
|
|
|
## 📝 문서 작성 가이드
|
|
|
|
### 문서 작성 원칙
|
|
- **명확성**: 기술 용어는 쉽게 설명
|
|
- **최신성**: 코드 변경 시 즉시 업데이트
|
|
- **완결성**: 독립적으로 이해 가능하도록 작성
|
|
- **예제 포함**: 코드 예제와 스크린샷 활용
|
|
|
|
### 마크다운 스타일
|
|
```markdown
|
|
# H1: 문서 제목 (한 문서에 한 개만)
|
|
## H2: 주요 섹션
|
|
### H3: 하위 섹션
|
|
|
|
- 리스트 사용
|
|
- 코드 블록 활용
|
|
- 테이블로 정보 정리
|
|
```
|
|
|
|
## 🔗 외부 리소스
|
|
|
|
- [프로젝트 README](../README.md)
|
|
- [데이터베이스 스키마](../DATABASE_SCHEMA.md)
|
|
- [MySQL 호환성 노트](../MYSQL_COMPATIBILITY_NOTES.md)
|
|
|
|
## 📅 문서 이력
|
|
|
|
| 날짜 | 버전 | 변경 내용 | 작성자 |
|
|
|------|------|----------|--------|
|
|
| 2025-12-11 | 1.0 | 문서 구조 초기 생성 | Claude Code |
|
|
|
|
## 📧 문의
|
|
|
|
문서 관련 질문이나 개선 제안은 프로젝트 관리자에게 문의하세요.
|