Skip to content

janggunie/docs

Repository files navigation

장군이 프로젝트 문서 저장소

**AI 기반 한국사 에듀테크 플랫폼 ‘장군이’**의 기획 · 설계 · 아키텍처 · 운영 · 데이터 수집 전 과정을 문서로 관리하는 저장소입니다.

🌄 Overview

“장군이”는 AI 기반 한국사 학습 플랫폼 으로, 퀴즈·챗봇·역사 시뮬레이션·오늘의 역사 브리핑 등 다양한 학습 기능을 제공합니다.

본 저장소는 프로젝트 전체 문서 시스템 을 관리합니다.


📂 Directory Structure

폴더 / 파일 설명
📁 features 주요 기능 명세서 (한국사 퀴즈, 챗봇, 시뮬레이션, 오늘의 역사 등)
├─ 01_quiz_spec.md RAG 기반 한국사 퀴즈 생성 기능 명세서
├─ 02_chatbot_spec.md 역사 인물 페르소나 챗봇 명세서
├─ 03_simulation_spec.md 텍스트 어드벤처형 역사 체험 시뮬레이션 명세서
└─ 04_today_history_contents_spec.md 오늘의 역사 브리핑/콘텐츠 명세서
📁 infra 서버 세팅, 배포, 운영 관련 매뉴얼
├─ 01_cloud_instance_initial_setup.md 클라우드 인스턴스 초기 FE/BE/DB/AI 세팅
├─ 02_ai_db_backend_deployment_guide.md AI·DB·백엔드·프론트엔드 통합 배포 가이드
├─ 03_server_operation_manual.md 팀원용 서버 운영 매뉴얼
└─ 04_instance_auto_start_guide.md 인스턴스 서비스 자동 실행 설정 가이드
📁 data-collection 데이터 수집 코드 및 원본 데이터 저장 폴더
├─ code/ 크롤링 코드 (.ipynb)
├─ dataset/ 수집된 CSV/JSON 원본 데이터
└─ README.md 데이터 수집 출처 및 방식 정리 문서
📁 assets 프로젝트 이미지, 캐릭터, 다이어그램
└─ characters/, diagrams .png/.jpg
📁 meeting 회의록 (YYYY-MM-DD_회의록.md)
📁 mentoring 멘토링 보고서(/.pdf)
📁 시연영상 서비스 전반 시연 영상 저장 폴더
📄 AINLP종합프로젝트계획서_장군이.md 프로젝트 전체 계획서
📄 AINLP종합프로젝트발표자료_장군이.pdf 최종 발표 자료
README.md 저장소 소개 및 문서 가이드

🧩 Features

기능 설명
알음풀이
한국사 퀴즈 생성
LLM + Vector DB 기반 자동 문제 생성
▶ 시연 영상 보기
말벗
역사 인물 페르소나 챗봇
인물별 말투/정보 기반 대화 제공
▶ 시연 영상 보기
연희놀이
역사 시뮬레이션
상황 기반 선택형 체험 콘텐츠
▶ 시연 영상 보기
오늘의 역사
오늘의 역사/조선 브리핑
특정 날짜의 역사적 사건 요약
▶ 시연 영상 보기

상세 내용은 /features/ 폴더 참고


🛠 Tech Stack

Application

  • Frontend: Next.js 14, TypeScript, Tailwind CSS
  • Backend: FastAPI, SQLAlchemy
  • Database: PostgreSQL, ChromaDB/FAISS
  • Infra: Nginx, Ubuntu 22.04, Uvicorn

AI & Data

  • LLM Engine:
    • Quiz/Chatbot: vLLM / Ollama (Llama-3-Korean-Bllossom-8B, Exaone 3.5)
    • Simulation/Summary: Google Gemini API (gemini-2.5-flash)
  • RAG: LangChain, Embeddings (ko-sbert-nli)
  • Data: Selenium, Pandas

📦 Data Collection

이 프로젝트의 상세 데이터 수집 내용은 아래에서 확인할 수 있습니다:

/data-collection/README.md

(연대기 / 조선왕조실록 / 오늘의 역사 이슈 등 세부 출처 및 스크립트 설명 포함)


🔗 Related Repositories


📄 Documentation Guideline

  • 기능 명세서 → /features/
  • 인프라 & 배포 문서 → /infra/
  • 데이터 수집 상세 → /data-collection/README.md
  • 아키텍처 다이어그램 → /assets/
  • 회의록/멘토링 → 날짜/버전 기준으로 관리
  • 루트에는 요약·구조·링크 중심 문서만 유지

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published