GitDiagram: GitHubコードベースの構造を視覚化し、コードリポジトリをインタラクティブなシステムアーキテクチャ図に変換します。

GitDiagram是一款创新的GitHub代码库可视化工具，能够将任何GitHub仓库快速转换为交互式系统架构图。它采用先进的AI技术（Claude 3.5 Sonnet），为开发者提供了一种全新的代码库浏览和理解方式。用户只需将GitHub URL中的”hub”替换为”diagram”，即可立即生成对应仓库的可视化图表。该工具不仅支持即时可视化转换，还提供了强大的交互功能，允许用户直接点击图表组件来导航至源代码文件和相关目录，大大提升了代码库的可读性和可理解性。GitDiagram采用现代化技术栈开发，包括Next.js、FastAPI和PostgreSQL等，确保了工具的高性能和可靠性。

経験：https://gitdiagram.com/

機能一覧

• 即座にビジュアル変換: GitHubのリポジトリ構造をシステム設計/アーキテクチャ図に素早く変換します。
• インテリジェントなインタラクティブナビゲーション：ダイアグラムのコンポーネントをクリックすることで、ソースファイルやディレクトリへの直接アクセスをサポート
• AI駆動ジェネレーション：クロード3.5ソネットでチャート生成の速度と精度を確保
• カスタマイズ：ユーザー指示によるチャートの修正と再生のサポート
• URL快捷访问：通过替换GitHub URL中的”hub”为”diagram”即可使用
• APIフルサポート：統合用のパブリックAPIインターフェースを提供（開発中）
• リアルタイム更新: コードベース構造への変更をリアルタイムで視覚的に更新。
• カスタムデプロイメント：完全なセルフホストデプロイメントソリューションが利用可能

ヘルプの使用

基本的な使用プロセス

• GitHub リポジトリの URL を入力するか、URL 変換メソッドを直接使用します。
• システムがインタラクティブなアーキテクチャ図を自動生成するのを待つ
• ダイアグラム内のコンポーネントをクリックすると、対応するソース・コード・ファイルに直接移動します。

使用制限の説明

現在の無料版には以下の使用制限があります：

• チャート作成リクエストは1分間に1回まで
• チャート作成リクエストは1日5件まで
• 制約から抜け出す必要がある場合、オプションの自己派遣プログラム

セルフホスト導入ガイド

1. 環境準備

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

2. 環境変数の設定
   • .env.exampleを.envにコピーする
   • Anthropic APIキーの設定
   • GitHubパーソナルアクセストークンのオプション設定
3. バックエンド・サービスの開始

   docker-compose up --build -d
   

   • バックエンドのサービスは localhost:8000 で実行されます。
   • docker-compose logs -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キーの使用を検討してください。