Merege to main

.dockerignore

@@ -0,0 +1,64 @@
+# Git
+.git
+.gitignore
+
+# Python
+__pycache__
+*.pyc
+*.pyo
+*.pyd
+.Python
+*.so
+*.egg
+*.egg-info
+dist
+build
+
+# Virtual Environment
+.venv
+venv/
+ENV/
+env/
+
+# IDE
+.vscode
+.idea
+*.swp
+*.swo
+*~
+
+# Environment
+.env
+.env.local
+
+# Documentation
+*.md
+!README.md
+
+# Database
+*.db
+*.sqlite
+*.sqlite3
+
+# Logs
+*.log
+logs/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Docker
+Dockerfile
+docker-compose.yml
+.dockerignore
+
+# CI/CD
+.github
+
+# Others
+alembic.ini
+manage_db.py
+create_migration.py
+init_questions.py
+credentials/

README.md

@@ -19,17 +19,143 @@ pip install -r requirements.txt
 
 ## 실행
 
+### 로컬 개발 환경
+
+개발 서버(Uvicorn) 실행:
+
+```bash
+uvicorn app.main:app --reload --port 8000
+```
+
+API 문서: `http://127.0.0.1:8000/docs`
+
+### Docker를 사용한 실행
+
+#### 1. 환경 변수 설정
+`.env` 파일에 AWS RDS 및 필요한 설정을 추가하세요:
+
+```env
+# 데이터베이스 (AWS RDS)
+DB_HOST=your-rds-endpoint.region.rds.amazonaws.com
+DB_PORT=3306
+DB_USER=admin
+DB_PASSWORD=your_password
+DB_NAME=caring_voice
+
+# AWS 설정
+AWS_ACCESS_KEY_ID=your_access_key
+AWS_SECRET_ACCESS_KEY=your_secret_key
+AWS_REGION=ap-northeast-2
+S3_BUCKET_NAME=your-bucket-name
+
+# Google Cloud 설정
+GOOGLE_APPLICATION_CREDENTIALS=/app/credentials/google-credentials.json
+```
+
+#### 2. Docker Compose로 서버 실행
+
+```bash
+# 빌드 및 실행
+docker-compose up -d
+
+# 로그 확인
+docker-compose logs -f
+
+# 중지
+docker-compose down
+```
+
+#### 3. API 접근
+- 로컬: `http://localhost:8000`
+- API 문서: `http://localhost:8000/docs`
+
+## 데이터베이스 마이그레이션
+
+### 자동 마이그레이션
+서버 시작 시 자동으로 마이그레이션이 실행됩니다.
+
+### 수동 마이그레이션
+```bash
+# 마이그레이션 파일 생성
+alembic revision --autogenerate -m "커밋 메시지"
+
+# 마이그레이션 실행
+alembic upgrade head
+
+# 마이그레이션 롤백
+alembic downgrade -1
+```
+
+## 질문 데이터 초기화
+
+질문 템플릿을 데이터베이스에 저장합니다:
+
 ```bash
-python -m app.main
+python init_questions.py
+```
+
+이 명령어는 다음 카테고리의 질문들을 자동으로 추가합니다:
+- emotion (14개)
+- stress (10개)
+- physical (10개)
+- social (10개)
+- self_reflection (15개)
+
+총 59개의 질문이 데이터베이스에 저장됩니다.
+
+## 환경 변수 설정
+
+프로젝트 루트에 `.env` 파일을 생성하고 다음 값을 채우세요. 예시는 `.env.example` 참고.
+
+```
+AWS_ACCESS_KEY_ID=...
+AWS_SECRET_ACCESS_KEY=...
+AWS_REGION=ap-northeast-2
+S3_BUCKET_NAME=your-bucket
+S3_PREFIX=voices
 ```
 
+### Google Cloud 설정
+```
+# 서비스 계정 키 파일 경로 설정 (Speech-to-Text, Natural Language API 공통)
+GOOGLE_APPLICATION_CREDENTIALS=/path/to/your/service-account-key.json
+```
+
+### 데이터베이스 설정
+```
+# MySQL 데이터베이스 연결 정보
+DB_HOST=localhost
+DB_PORT=3306
+DB_USER=root
+DB_PASSWORD=your_password
+DB_NAME=table_name
+```
+
+`.env`는 `app/database.py`에서 자동 로드됩니다.
+
+> 💡 **배포 환경**: 운영 환경에서는 환경변수를 시스템에 직접 설정하거나, `.env` 파일을 사용하지 않고 컨테이너/Docker의 환경변수 설정을 사용하세요.
+
+## API 엔드포인트
+
+### 음성 관련 API
+- `POST /voices/upload`: 음성 파일 업로드 + STT 변환
+- `POST /voices/transcribe`: STT 변환만
+- `POST /voices/{voice_key}/analyze-emotion`: S3 파일 감정 분석
+- `GET /voices`: 파일 목록 조회
+
+### 텍스트 분석 API (Google Natural Language)
+- `POST /nlp/sentiment`: 텍스트 감정 분석
+- `POST /nlp/entities`: 엔티티 추출
+- `POST /nlp/syntax`: 구문 분석
+- `POST /nlp/analyze`: 종합 텍스트 분석
+
 ## 프로젝트 구조
 
 ```
 caring-voice/
 ├── app/
 │   ├── __init__.py
-│   └── main.py          # 메인 엔트리 포인트
+│   └── main.py          # FastAPI 엔트리 포인트 및 엔드포인트
 ├── .gitignore
 ├── README.md
 ├── requirements.txt

alembic.ini

@@ -0,0 +1,60 @@
+# Alembic 설정 파일
+
+[alembic]
+# 마이그레이션 파일 위치
+script_location = migrations
+
+# 버전 파일 이름 형식
+file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# SQLAlchemy URL
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+# 서버 인코딩
+prepend_sys_path = .
+
+# 로그 레벨
+log_level = INFO
+
+# UTC 타임스탬프 사용
+date_format = %%Y-%%m-%%d %%H:%%M:%%S
+
+# 제외할 테이블 패턴
+exclude_tables = 
+
+[post_write_hooks]
+
+# 로그 출력
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

app/__init__.py

@@ -0,0 +1,3 @@
+from dotenv import load_dotenv  # type: ignore
+load_dotenv()
+