01 프로젝트 설명

2024.09.25 - 2024.09.26

문서 작성이 힘든 개발자들을 위한 AI & 대시보드 기반의 프로젝트 문서 간편화 솔루션

https://youtu.be/ujjDUCRQnwg

📍주요 기능

1. MAKE README: 프로젝트 리드미 생성

• AI를 통한 README 자동 생성 템플릿 제공
• 마크다운 대시보드 기반 수정 가능

2. MAKE DIAGRAM: 프로젝트 다이어그램 생성

• AI 다이어그램 자동 생성 기능
  • ERD
  • 시퀀스 다이어그램
  • 클래스 다이어그램
• 시각 편집 가능한 대시보드 제공

3. MAKE GITHUB REPORT: 협업 리포트 제작

• GitHub 커밋/기여도 시각화 리포트 생성
• 회고 방법 추천
• 이미지 다운로드 기능 지원

02 주요 기여

📍BE

• ERD 작성
• GIthub 소셜로그인 : Oauth를 사용한 소셜로그인
• Github API 사용 : 서비스 관리 및 프로젝트 문서 작성을 위해 정보를 얻어오기 위해 API 사용
• 메인페이지, 리드미 페이지, 깃허브 리포트 페이지, 마이페이지 기본 CURD API 구현
• JPA 기본 쿼리 이외의 쿼리문을 통해 원하는 DB 정보 빼오기
• 자원 관리

📍FE

• GIthub api & TypeScript(D3.js) 라이브러리를 사용한 github report 제작

📍Infra

• Docker & Github Action을 이용한 CI/CD 구축

  Github Action & Docker를 이용한 CI/CD(백엔드)

• AWS(RDS, EC2, S3) 배포 및 서버 관리

  • S3 배포

03 트러블 슈팅

• Docker container 실행 시 종료 코드 1로 계속 종료되는 상황 - Dockerfile에서 src/main/resources 디렉토리를 복사하지 않아, 해당 디렉토리 내의 파일들에 접근할 수 없는 오류
  • 문제 상황
  • 원인
  • 설명 & 해결방안
• OpenAI 및 머메이드 문법을 사용한 다이어그램 생성에 간헐적인 오류 발생
  • 문제 상황
  • 해결 방안
• local 에서는 정상 작동하던 깃허브 레포드 생성 → deploy 에서는 500 오류 뜨는 경우
  • 문제 상황
  • 원인
  • 해결 방안
• docker container 의 종료코드가 1로 계속 종료되는 상황1 - 환경변수 설정 부분
  • 문제 상황
  • 원인
  • 설명 & 해결 방안