gitdiagram

KO | EN

gitlite — search

#python #ai #golang #android #machine-learning #docker #macos #nodejs #java #cli #pytorch #security #mcp #openai

(★ 15,888)

모든 GitHub 리포지토리를 위한 무료, 간단하고 빠른 대화형 다이어그램

gitdiagram 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![GitDiagram front page](https://raw.githubusercontent.com/ahmedkhaleel2004/gitdiagram/main/docs/readme_img.png)](https://gitdiagram.com/)

![License](https://img.shields.io/badge/license-MIT-blue.svg)
[![Ko-fi](https://img.shields.io/badge/Ko--fi-F16061.svg?logo=ko-fi&logoColor=white)](https://ko-fi.com/ahmedkhaleel2004)

# GitDiagram

공개 또는 비공개 GitHub 저장소를 몇 초 만에 대화형 아키텍처 다이어그램으로 변환하세요.

또한 GitHub URL의 `hub`를 `diagram`으로 교체하여 해당 다이어그램을 열 수 있습니다.

> **스폰서 슬롯:** 코드를 적극적으로 탐색 중인 개발자들에게 도달하세요. [GitDiagram 스폰서 되기](https://gitdiagram.com/sponsor).

## 기능

- **아키텍처 중심 다이어그램:** 단순한 폴더 그리기를 넘어 저장소 트리와 README를 시스템 수준의 그래프로 변환합니다.
- **대화형 소스 링크:** 컴포넌트를 클릭하여 GitHub의 실제 파일이나 디렉터리를 엽니다.
- **스트리밍 생성:** 그래프가 계획되는 동안 설명이 도착하는 과정을 실시간으로 확인하세요.
- **비공개 저장소:** 브라우저에 로컬로 GitHub 토큰을 제공하며, 비공개 아티팩트는 별도의 보호된 스토리지 네임스페이스를 사용합니다.
- **내보내기:** Mermaid 소스를 복사하거나 렌더링된 다이어그램을 PNG로 다운로드합니다.
- **제공자 선택:** 기본값은 OpenAI이며, 자체 호스팅 배포의 경우 OpenRouter를 사용할 수 있습니다.

## 스택

- **애플리케이션:** Next.js 16 App Router, React 19, TypeScript, Tailwind CSS 및 Radix UI
- **생성 API:** Vercel의 Bun 런타임에서 실행되는 동일 출처(same-origin) Next.js Route Handlers
- **스토리지:** 다이어그램 아티팩트를 위한 Cloudflare R2
- **조율:** 할당량 회계, 취소, 잠금 및 단기 실패 상태를 위한 Upstash Redis
- **AI:** `AI_PROVIDER`를 통한 OpenAI 또는 OpenRouter
- **분석:** PostHog
- **배포:** Vercel이 유일한 라이브 런타임이며, 재해 복구를 위해 오프라인 Railway/Docker 레시피가 유지됩니다.

별도의 FastAPI 구현, Postgres 데이터베이스 또는 Neon 런타임은 존재하지 않습니다.

## 프로덕션 아키텍처

Vercel은 UI와 생성 엔드포인트를 모두 서빙합니다:

- `/api/generate/cost`는 제한된 GitHub 수집 후 실행 비용을 추정하며, 동일 출처 및 속도 제한이 적용됩니다.
- `/api/generate/stream`은 설명 및 그래프 진행 상황을 위한 Server-Sent Events를 스트리밍합니다.
- `/api/generate/cancel`은 인증된 동일 출처 취소 신호를 기록합니다.
- `/api/diagram-state`는 지속화된 결과 계약을 읽고 씁니다.
- `/api/healthz`는 경량 배포 상태 확인을 제공합니다.

장시간 실행되는 생성 작업은 300초의 Vercel 함수 예산을 사용하며, 할당량 조정 및 지속화가 완료될 시간을 확보하기 위해 애플리케이션 마감 시간은 더 짧게 설정됩니다. 요청은 프로세스 로컬 상태 대신 명시적인 업스트림 마감 시간, 재시도, 구조화된 로그, 하트비트 및 분산 취소를 사용합니다.

동일한 Next.js 애플리케이션을 Railway용 최소형 비루트(non-root) 독립형 Docker 이미지로 빌드할 수도 있습니다. 활성화된 Railway 서비스, 소스 연결 또는 Railway 도메인은 유지되지 않습니다. 체크인된 `Dockerfile`과 `railway.json`은 두 번째 백엔드 구현을 부활시키지 않고도 나중에 전체 애플리케이션을 다시 생성할 수 있는 콜드 복구 레시피입니다. [docs/deployment-failover.md](docs/deployment-failover.md)를 참고하세요.

## 생성 작동 방식

1. GitDiagram은 GitHub API를 통해 리포지토리의 기본 브랜치, 재귀 트리, README를 가져옵니다. 모델 작업이 시작되기 전에 잘린 트리와 너무 큰 입력은 거부됩니다.
2. 첫 번째 모델 단계는 평이한 영어로 된 아키텍처 설명을 스트리밍합니다.
3. 두 번째 단계는 엄격하고 크기가 제한된 그래프 AST(그룹, 노드, 엣지, 모양, 레이블, 설명, 리포지토리 경로)를 반환합니다.
4. 서버는 식별자, 그래프 연결성, 제한 사항, 그리고 실제 리포지토리에 대한 모든 링크된 경로를 검증합니다. 잘못된 출력은 구체적인 피드백과 함께 재시도됩니다.
5. 결정론적 컴파일러는 검증된 AST를 완전한 텍스트 이스케이프 및 GitHub 전용 링크가 포함된 Mermaid로 변환합니다.
6. 브라우저는 소스를 정화하고, 엄격한 보안 모드에서 Mermaid를 렌더링하며, 결과 SVG를 정화하고, 링크 허용 목록을 다시 적용합니다.
7. 성공적인 아티팩트와 터미널 감사 상태가 유지되므로, 나중에 방문할 때 다른 모델 호출 없이 다이어그램을 다시 열 수 있습니다.

전체 Mermaid 파서는 컴파일러 계약 테스트로서 테스트 스위트에 유지됩니다. 다이어그램 유효성 검사이나 브라우저 안전성을 저해하지 않으면서 서버 번들을 작게 유지하기 위해 프로덕션 생성 함수에는 의도적으로 로드되지 않습니다.

## State

- **성공적인 공개 생성:** 리포지토리별로 키가 지정된 R2 객체
- **성공적인 비공개 생성:** 서버 측 비밀로 파생된 별도의 R2 네임스페이스
- **무료 할당량 및 활성 취소 토큰:** Upstash Redis
- **저장된 아티팩트가 없는 터미널 실패:** 수명이 짧은 Upstash 상태
- **동시 쓰기:** 분산 잠금 및 최신 세션 우선 유지 지속성

## Private repositories

헤더에서 **Private Repos**를 선택하고 대상 리포지토리를 읽을 수 있는 세분화된 GitHub 개인용 액세스 토큰을 제공하세요. 이 토큰은 관련 동일 출처 요청과 함께만 전송되며 공개 다이어그램 링크에 절대 포함되지 않습니다.

## Local development

정확한 사전 요구 사항 및 환경 세부 정보는 [docs/dev-setup.md](docs/dev-setup.md)를 참조하세요.

```bash
git clone https://github.com/ahmedkhaleel2004/gitdiagram.git
cd gitdiagram
bun install
cp .env.example .env
bun run dev
```

[http://localhost:3000](http://localhost:3000)을 엽니다.

최소한 `.env`에 R2, Upstash, 그리고 하나의 AI 제공업체를 구성해야 합니다. GitHub PAT 또는 GitHub App은 선택 사항이지만 더 높은 GitHub API 제한을 위해 강력히 권장됩니다.

풀 리퀘스트를 열기 전에 전체 로컬 게이트를 실행하세요.

```bash
bun run lint
bun run typecheck
bun run test
bun run build
```

## Contributing

기여를 환영합니다. 집중된 설명과 검증 메모와 함께 이슈나 풀 리퀘스트를 열어주세요.

## Acknowledgements

[Romain Courtois](https://github.com/cyclotruc)의 [Gitingest](https://gitingest.com/)에서 영감을 받았습니다.

gitdiagram

gitdiagram 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

gitdiagram

gitdiagram 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README