Skip to content

Quick Start

Get GitInspectorGUI development environment running in one command.

Prerequisites: Complete Prerequisites and Installation first.

Note: This is for the development environment. For application usage, see gitinspectorgui.readthedocs.io.

Single-Step Verification

After completing installation, verify everything works with this single step:

Start Development Environment

pnpm run tauri dev

What happens:

  • Vite builds the React/TypeScript frontend
  • Tauri compiles the Rust wrapper with PyO3 integration
  • Python analysis engine is embedded directly in the application
  • Desktop app opens with fully integrated Python functionality

Verify Integration

  • Desktop app opens with GitInspectorGUI interface
  • Python analysis engine is ready for use (no separate server needed)
  • Test with sample repository analysis through the GUI
  • Check that results are displayed properly

Development Commands Reference

For ongoing development, use these commands:

# Complete development environment (recommended)
pnpm run tauri dev

# Frontend only (without desktop wrapper)
pnpm run dev

# Note: Python changes require restarting the desktop app
# since Python is embedded via PyO3

Next Steps

Now that your environment is working:

Troubleshooting

If something doesn't work:

  1. Check Prerequisites: Ensure all tools from Prerequisites are installed
  2. Verify Installation: Re-run verification steps from Installation
  3. Common Issues: See Troubleshooting Guide

Quick fixes:

# Desktop app won't start
pnpm clean
pnpm install
pnpm run tauri dev

# Dependencies issues
uv sync && pnpm install

# Clear development cache
rm -rf node_modules/.vite
rm -rf src-tauri/target/debug

Common Issues

Desktop app won't start:

# Check Rust/Tauri installation
rustc --version
pnpm run tauri --version

# Clear and reinstall frontend dependencies
rm -rf node_modules pnpm-lock.yaml
pnpm install

Python integration errors:

# Check Python environment
python -c "import gigui; print('OK')"

# Reinstall Python dependencies
uv sync

# Clear Tauri cache
rm -rf src-tauri/target/debug

Getting Debug Information

  1. Application logs: Check the terminal where you started pnpm run tauri dev
  2. Frontend logs: Right-click in the desktop app → "Inspect" → "Console" tab
  3. Python debugging: Add print statements to Python code and restart the app

Next Steps

After successful testing:

  1. Development Workflow - Learn development patterns and best practices
  2. CLI Development Guide - Command-line development
  3. API Reference - Backend API documentation
  4. Architecture Overview - Understanding the system design