Skip to content

[Docs] README 작성 #143

Closed
Closed

Description

@hwiyoon20010309

어떤 기능인가요?

프로젝트 최상위 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 자동 배포)
  • Contributors 정리

체크 리스트

  • 서비스 소개 및 한 줄 요약 작성
  • Tech Stack 표 작성
  • 아키텍처 다이어그램 작성
  • 주요 기능 요약표 작성
  • 도메인별 상세 API 명세 작성
  • CI/CD 파이프라인 설명 작성
  • Contributors 표 작성

로컬 테스트 완료

로컬에서 테스트한 결과가 잘 나오는지 확인해주세요.

테스트 결과를 스크린샷으로 올려주세요.

기타

(스크린샷 등) 기타 사항을 작성해주세요.

Activity

  1. linked a pull request that will close this issue[Docs] README 작성 #144on Aug 12, 2026
  2. added a commit that references this issue on Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions