GitDiagram: GitHub 코드 저장소의 구조를 시각화하고 코드 저장소를 대화형 시스템 아키텍처 다이어그램으로 변환합니다.

일반 소개

GitDiagram은 모든 GitHub 리포지토리를 대화형 시스템 아키텍처 다이어그램으로 빠르게 변환하는 혁신적인 GitHub 코드베이스 시각화 도구입니다. 이 도구는 고급 AI 기술(Claude 3.5 Sonnet)을 사용하여 개발자에게 코드베이스를 보고 이해하는 새로운 방법을 제공합니다. 사용자는 GitHub URL에서 '허브'를 '다이어그램'으로 바꾸기만 하면 해당 리포지토리에 대한 시각적 다이어그램을 즉시 생성할 수 있습니다. GitDiagram은 Next.js, FastAPI, PostgreSQL 등 최신 기술 스택을 사용하여 개발되었기 때문에 높은 성능과 안정성을 보장합니다. 높은 성능과 안정성.

체험: https://gitdiagram.com/

기능 목록

• 즉각적인 시각적 변환: GitHub 리포지토리 구조를 시스템 설계/아키텍처 다이어그램으로 빠르게 변환합니다.
• 지능형 대화형 탐색: 다이어그램 구성 요소를 클릭하여 소스 파일 및 디렉토리에 직접 액세스 지원
• AI 기반 생성: Claude 3.5 Sonnet으로 차트 생성의 속도와 정확성 보장
• 사용자 지정: 사용자 지침에 따라 차트 수정 및 재생성 지원
• URL 바로 가기: '허브'를 '다이어그램'으로 대체하여 GitHub URL을 사용합니다.
• 전체 API 지원: 통합을 위한 공용 API 인터페이스 제공(개발 중)
• 실시간 업데이트: 코드 베이스 구조에 대한 변경 사항을 실시간으로 시각적으로 업데이트할 수 있도록 지원합니다.
• 사용자 지정 배포: 완벽한 셀프 호스팅 배포 솔루션 사용 가능

도움말 사용

기본 사용 프로세스

• GitHub 리포지토리 URL을 입력하거나 URL 변환 방법을 사용하세요.
• 시스템이 대화형 아키텍처 다이어그램을 자동으로 생성할 때까지 기다리기
• 다이어그램에서 컴포넌트를 클릭하면 해당 소스 코드 파일로 바로 이동합니다.

사용 제한에 대한 설명

현재 무료 버전에는 다음과 같은 사용 제한 사항이 있습니다:

• 분당 차트 생성 요청 1건으로 제한
• 하루 차트 생성 요청 5건으로 제한
• 제약 조건에서 벗어나야 하는 경우 자체 배포 프로그램(선택 사항)

셀프 호스팅 배포 가이드

1. 환경 준비

   git clone https://github.com/ahmedkhaleel2004/gitdiagram.git
   cd gitdiagram
   pnpm i
   

2. 환경 변수 구성
   • .env.example를 .env에 복사합니다.
   • 익명 API 키 구성
   • GitHub 개인 액세스 토큰의 선택적 구성
3. 백엔드 서비스 시작

   docker-compose up --build -d
   

   • 백엔드 서비스는 localhost:8000에서 실행됩니다.
   • docker-compose log -f로 로그 보기
4. 데이터베이스 설정

   chmod +x start-database.sh
   ./start-database.sh
   pnpm db:push
   

   • 데이터베이스는 localhost:5432에서 실행됩니다.
   • pnpm db:studio를 사용하여 데이터베이스를 보고 관리할 수 있습니다.
5. 프런트엔드 서비스 시작

   pnpm dev
   

   • 로컬로 배포된 버전을 사용하려면 localhost:3000을 방문하세요.

고급 기능 사용

1. 사용자 지정 명령
   • 인터페이스를 통해 사용자 지정 명령을 제공하여 차트 생성 방법을 수정할 수 있습니다.
   • 특정 코드 기반 구조의 시각화 요구 사항에 맞게 조정 지원
2. API 통합
   • 개발 중인 공개 API는 타사 시스템 통합을 지원합니다.
   • API를 통해 자동화할 수 있는 코드베이스 시각화

팁 및 유용한 정보

1. 대형 물류창고의 경우
   • 먼저 주요 모듈의 구조에 집중하는 것이 좋습니다.
   • 대화형 탐색을 통한 단계별 세부 정보 드릴다운
2. 성능 최적화
   • 자체 호스팅 솔루션을 사용하면 기본 제한을 해제할 수 있습니다.
   • 더 나은 성능을 위해 자체 Anthropic API 키를 사용하는 것이 좋습니다.