GitDiagram : Visualisez la structure de votre base de code GitHub et transformez votre dépôt de code en un diagramme d'architecture de système interactif.

Introduction générale

GitDiagram est un outil innovant de visualisation de la base de code GitHub qui transforme rapidement n'importe quel dépôt GitHub en un diagramme interactif de l'architecture du système. Il utilise une technologie d'IA avancée (Claude 3.5 Sonnet) pour donner aux développeurs une nouvelle façon de voir et de comprendre leur base de code. Les utilisateurs remplacent simplement "hub" par "diagram" dans l'URL GitHub pour générer instantanément un diagramme visuel du dépôt correspondant. GitDiagram est développé à l'aide d'une pile technologique moderne, notamment Next.js, FastAPI et PostgreSQL, ce qui garantit des performances et une fiabilité élevées. Haute performance et fiabilité.

Expérience : https://gitdiagram.com/

Liste des fonctions

• Conversion visuelle instantanée : conversion rapide de la structure du dépôt GitHub en diagrammes de conception/architecture du système
• Navigation interactive intelligente : accès direct aux fichiers sources et aux répertoires en cliquant sur les éléments du diagramme.
• Génération pilotée par l'IA : Assurer la rapidité et la précision de la génération de graphiques avec Claude 3.5 Sonnet
• Personnalisation : possibilité de modifier et de régénérer les graphiques selon les instructions de l'utilisateur
• Raccourcis d'URL : Utilisez l'URL de GitHub en remplaçant "hub" par "diagram".
• Prise en charge complète de l'API : fournir une interface API publique pour l'intégration (en cours de développement)
• Mises à jour en temps réel : mise à jour visuelle en temps réel des modifications apportées à la structure de la base de code
• Déploiement personnalisé : solution complète de déploiement autonome disponible

Utiliser l'aide

Processus d'utilisation de base

• Saisir l'URL du dépôt GitHub ou utiliser directement la méthode de conversion d'URL
• Attendre que le système génère automatiquement un diagramme d'architecture interactif
• Cliquez sur un composant du diagramme pour accéder directement au fichier de code source correspondant.

Description des restrictions d'utilisation

La version gratuite actuelle comporte les restrictions d'utilisation suivantes :

• Limite de 1 demande de génération de graphique par minute
• Limite de 5 demandes de génération de graphiques par jour
• Programme d'auto-déploiement facultatif si vous avez besoin de vous libérer des contraintes

Guide de déploiement en auto-hébergement

1. Préparation de l'environnement

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

2. Configuration des variables d'environnement
   • Copier .env.example vers .env
   • Configuration des clés API d'Anthropic
   • Configuration optionnelle des jetons d'accès personnels GitHub
3. Démarrage des services back-end

   docker-compose up --build -d
   

   • Le service back-end sera exécuté sur localhost:8000
   • Affichage des journaux avec docker-compose logs -f
4. Paramètres de la base de données

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

   • La base de données sera exécutée sur localhost:5432
   • En utilisant pnpm db:studio, vous pouvez visualiser et gérer des bases de données.
5. Démarrage des services frontaux

   pnpm dev
   

   • Visitez localhost:3000 pour utiliser la version déployée localement

Utilisation des fonctions avancées

1. Commandes personnalisées
   • La génération de graphiques peut être modifiée en fournissant des commandes personnalisées via l'interface.
   • Adaptation aux besoins de visualisation d'une structure de base de code particulière
2. Intégration de l'API
   • Les API publiques en cours de développement permettront l'intégration de systèmes tiers.
   • Visualisation de la base de code pouvant être automatisée par le biais d'API

Conseils et astuces

1. Pour les grands entrepôts
   • Il est recommandé de se concentrer d'abord sur la structure des principaux modules
   • Approfondissement des détails étape par étape grâce à une navigation interactive
2. l'optimisation des performances
   • L'utilisation d'une solution auto-hébergée permet de s'affranchir des limitations par défaut
   • Envisagez d'utiliser votre propre clé API Anthropic pour de meilleures performances.