GitInspectorGUI Developer Documentation

Development environment and tooling documentation for GitInspectorGUI contributors.

Note: For application usage and features, see the main documentation at gitinspectorgui.readthedocs.io.

Quick Navigation

Try the Demo

• Interactive Demo - Try GitInspectorGUI in your browser without installation

New to the Project?

• Technology Primer - Understanding the development tools
• Prerequisites - System requirements and tool installation
• Installation Guide - Detailed setup
• Quick Start - Get running in 3 steps

Development

• Development Workflow - Core development patterns
• Package Management - Dependencies and tools
• Build Process - Creating releases
• Environment Setup - Development configuration
• Troubleshooting - Common issues

Command Line Interface

• CLI Guide - Complete command-line usage
• First Analysis - Test your setup

API Development

• HTTP API Reference - Complete API documentation
• API Examples - Usage patterns and code samples
• Error Handling - Error codes and troubleshooting

Architecture & Operations

• System Overview - System architecture
• Technology Stack - Technology choices
• Design Decisions - Architectural rationale
• Release & Distribution - Production deployment
• Server Management - Operational procedures

Features

• HTTP API Architecture - Tauri desktop frontend with Python backend
• Cross-Platform - Windows, macOS, Linux support
• Git Analysis - Comprehensive repository insights
• Interactive UI - React-based interface with filtering
• Developer API - Complete HTTP API documentation

Architecture

graph TD
    A[Tauri Frontend] --> B[HTTP Client]
    B --> C[Python HTTP Server]
    C --> D[Git Analysis Engine]
    D --> E[Repository Data]

    F[Settings] --> A
    G[Results Store] --> A
    H[API Types] --> B