GitDiagram: визуализация структуры вашей кодовой базы GitHub и превращение вашего хранилища кода в интерактивную диаграмму архитектуры системы.

Общее введение

GitDiagram - это инновационный инструмент визуализации кодовой базы GitHub, который быстро превращает любой репозиторий GitHub в интерактивную диаграмму архитектуры системы. Он использует передовую технологию искусственного интеллекта (Claude 3.5 Sonnet), чтобы предоставить разработчикам новый способ просмотра и понимания их кодовой базы. Пользователям достаточно заменить "hub" на "diagram" в URL-адресе GitHub, чтобы мгновенно сгенерировать визуальную диаграмму соответствующего репозитория. GitDiagram разработан с использованием современного технологического стека, включая Next.js, FastAPI и PostgreSQL, что обеспечивает высокую производительность и надежность. Высокая производительность и надежность.

Опыт работы: https://gitdiagram.com/

Список функций

• Мгновенное визуальное преобразование: быстрое преобразование структуры репозитория GitHub в диаграммы системного дизайна/архитектуры
• Интеллектуальная интерактивная навигация: поддержка прямого доступа к исходным файлам и каталогам путем нажатия на компоненты диаграммы
• Генерация, управляемая искусственным интеллектом: обеспечение скорости и точности генерации диаграмм с помощью Claude 3.5 Sonnet
• Персонализация: поддержка модификации и регенерации графиков в соответствии с инструкциями пользователя
• Сокращение URL: используйте URL GitHub, заменив "hub" на "diagram".
• Полная поддержка API: предоставление публичного интерфейса API для интеграции (находится в разработке).
• Обновления в реальном времени: поддержка визуальных обновлений изменений в структуре кодовой базы в реальном времени
• Индивидуальное развертывание: доступно полное решение для самостоятельного развертывания

Использование помощи

Основной процесс использования

• Введите URL-адрес репозитория GitHub или воспользуйтесь методом преобразования URL-адреса напрямую
• Ожидание, пока система автоматически сгенерирует интерактивную диаграмму архитектуры
• Щелкните компонент на диаграмме, чтобы перейти непосредственно к соответствующему файлу исходного кода.

Описание ограничений на использование

Текущая бесплатная версия имеет следующие ограничения по использованию:

• Ограничение на 1 запрос генерации графика в минуту
• Ограничение на 5 запросов генерации графиков в день
• Факультативная программа саморазвертывания, если вам нужно вырваться из ограничений

Руководство по самостоятельному развертыванию

1. Подготовка к защите окружающей среды

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

2. Настройка переменных среды
   • Скопируйте .env.example в .env
   • Настройка ключей API Anthropic
   • Дополнительная настройка персональных токенов доступа 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. оптимизация производительности
   • Использование самостоятельного решения может нарушить стандартные ограничения
   • Рассмотрите возможность использования собственного ключа API Anthropic для повышения производительности