このプロジェクトについて

GitDiagramは、公開または非公開のGitHubリポジトリをインタラクティブなアーキテクチャ図に変換します。ユーザーは任意のGitHub URLで「hub」を「diagram」に置き換えて可視化を生成するか、gitdiagram.comのWebインターフェースを利用できます。 主な機能は次のとおりです。 - リポジトリのアーキテクチャに関する説明をストリーミングで表示するAI生成図 - リポジトリ内の対応するファイルまたはディレクトリに直接リンクするクリック可能なコンポーネント - 「Private Repos」ヘッダーオプションを通じたGitHubトークン認証による非公開リポジトリのサポート - PNG画像のダウンロードやMermaidソースコードのコピーを含むエクスポートオプション このプロジェクトは、Next.js、React、TypeScript、Tailwind CSS、Mermaidで構築されています。ローカル展開には、Bun、Cloudflare R2、Upstash Redis、およびOpenAIまたはOpenRouterのAPIキーが必要です。このプロジェクトはVercelに展開され、Railway/Dockerのフォールバックオプションが展開復旧ガイドに記載されています。 ドキュメントには、生成パイプライン、ストレージ、APIを扱うアーキテクチャ概要と、開発セットアップガイドが含まれています。このツールはRomain CourtoisのGitingestプロジェクトに触発され、MITライセンスの下で提供されています。