Traffic Accident Legal RAG

이 프로젝트는 교통사고 관련 법률 문서(민사/형사) 를 기반으로
RAG(Retrieval-Augmented Generation) 방식의 질의응답 서비스를 구현하는 프로젝트입니다.

여러 명이 GPT + Cursor로 병렬 개발하는 것을 전제로 설계되어 있으며,
폴더 소유권과 작업 규칙을 엄격히 분리하여 충돌을 방지합니다.

🚦 가장 중요한 작업 원칙 (필독)

1. 본인 담당 폴더만 수정합니다.
2. 다른 폴더는 읽기만 하고 직접 수정하지 않습니다.
3. /80_shared는 합의 없이 수정하지 않습니다.
4. 인프라/배포는 신경 쓰지 않아도 됩니다.
5. 코드 수정 후 git push 하면 자동 배포됩니다.

이 원칙만 지키면 됩니다.

👤 역할별 작업 범위

🗂️ 지우 — 데이터 수집 / 가공

• 작업 폴더: /10_data
• json / csv → utf-8 텍스트로 정제
• 결과물은 /10_data/processed에 저장

🧠 대연 — 인덱싱 / Backend (FastAPI)

• 작업 폴더: /20_indexing, /30_backend
• 청킹 / 임베딩 / 벡터DB 적재
• FastAPI API 서버 개발

🤖 은구 — RAG / LLM / Frontend

• 작업 폴더: /40_rag, /50_frontend
• RAG 로직, LLM 연동
• 사용자 화면(UI) 개발

🛠️ 성배 — 인프라 / 배포 / DB

• 작업 폴더: /60_infra
• HuggingFace Spaces 배포
• CI/CD, DB 생성 및 접근 관리
• 다른 팀원은 인프라를 수정하지 않습니다

🧩 공통 영역 (중요)

/80_shared

• DB 구조(schema) 와 API 계약(contract) 의 단일 진실원(SSOT)
• 변경 필요 시:
  1. 변경 제안
  2. 팀 합의
  3. 최종 반영
• 합의 없이 직접 수정 ❌

🚀 배포 및 실행 안내

• 배포는 HuggingFace Spaces를 통해 자동으로 이루어집니다.
• 팀원은 서버/배포 설정을 몰라도 됩니다.
• 본인 담당 폴더에서 작업 후 git push 하면 자동 반영됩니다.
• 실행 오류나 배포 문제가 발생하면 인프라 담당자에게 알려주세요.

📄 문서 위치 안내

• 협업 규칙 / 소유권: /00_admin
• 데이터 가공 산출물: /10_data
• 인덱싱 파이프라인: /20_indexing
• Backend(FastAPI): /30_backend
• RAG / LLM 로직: /40_rag
• Frontend: /50_frontend
• 인프라 / 배포: /60_infra
• 발표 자료 / 문서: /70_docs
• 공통 계약 / DB 구조: /80_shared
• 원본 자료 임시 보관: /99_source
  • 수집한 PDF 및 원본 문서 보관용
  • 전처리/인덱싱 파이프라인에서 직접 사용하지 않음

✅ 요약 (이것만 기억하세요)

• 내 폴더만 수정
• shared는 제안만
• 인프라는 신경 안 써도 됨
• push = 배포

이 규칙만 지키면 프로젝트는 문제없이 진행됩니다.

🔗 Links

• Project Main (소개/랜딩): https://huggingface.co/spaces/SungBae74/traffic-accident-legal-rag
• Demo UI (Gradio): https://sungbae74-traffic-accident-legal-rag.hf.space/ui/
• API Docs (Swagger): https://sungbae74-traffic-accident-legal-rag.hf.space/docs
• OpenAPI JSON: https://sungbae74-traffic-accident-legal-rag.hf.space/openapi.json
• Health Check: https://sungbae74-traffic-accident-legal-rag.hf.space/health