You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
프로젝트 최상위 README.md를 작성합니다. 서비스 소개, 기술 스택, 아키텍처, 주요 기능, API 명세, CI/CD, 컨트리뷰터 정보를 한 문서에서 확인할 수 있도록 정리합니다.
상세 내용
현재 레포지토리에는 README가 없어 신규 합류자나 외부 방문자가 서비스 개요·기술 스택·API 구조를 파악하기 어렵습니다. 코드베이스(build.gradle, 각 도메인 컨트롤러, GitHub Actions 워크플로, docker-compose.yml, git 커밋 이력)를 기준으로 아래 내용을 정리해 README.md에 반영합니다.
서비스 한 줄 소개 및 상세 소개
Tech Stack (Java/Spring Boot, JPA/MySQL, Security/JWT/OAuth2, OpenAI·Qdrant 기반 RAG, S3, 카카오페이 등)
아키텍처 다이어그램 (Client → API 서버 → MySQL/Qdrant/OpenAI/S3/카카오페이)
주요 기능 요약 (자료 관리, 챗봇(RAG), 티칭맵, 폴더·태그, 인증, 결제, 부가기능)
도메인별 상세 API 엔드포인트 명세
CI/CD 파이프라인 설명 (PR 빌드 검증 → main 배포 시 ECR/EC2 자동 배포)
Activity
Merge pull request #144 from TeachING-Dev/docs/#143/project-readme