Skip to content

Installation

Set up the GitInspectorGUI development environment after installing prerequisites.

Prerequisites: Complete Prerequisites first - you need Python 3.8+, Node.js 22+, Rust 1.63+, and package managers installed.

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

Project Setup

1. Clone Repository

Clone the repository and navigate to the project directory:

git clone https://github.com/boost-edu-tools/gitinspectorgui.git
cd gitinspectorgui

2. Install Dependencies

Now we'll install dependencies for both the Python backend and the React/TypeScript frontend.

Python Backend Setup

First, create a Python virtual environment:

uv venv

This creates an isolated Python environment in the .venv directory.

Next, activate the virtual environment:

On macOS/Linux:

source .venv/bin/activate

On Windows:

.venv\Scripts\activate

Note for Windows users: If you get an execution policy error in PowerShell, run:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Now install the Python dependencies:

uv sync

This reads pyproject.toml and installs all Python packages needed for the analysis engine that will be embedded via PyO3.

Frontend Setup

Install JavaScript/TypeScript dependencies:

pnpm install

This reads package.json and installs all React/TypeScript packages needed for the UI.

Install Tauri CLI globally:

pnpm add -g @tauri-apps/cli

This gives you the tauri command for building desktop applications.

Note: For more detailed information about package management in this project, including advanced usage of uv and pnpm, see the Package Management documentation.

Development Environment Setup

Python Environment Configuration

If using VS Code:

  1. Ctrl+Shift+P → "Python: Select Interpreter"
  2. Choose .venv/bin/python (created by uv venv)

Troubleshooting

Common Issues

Python module not found:

Reinstall dependencies:

uv sync

Rust compilation errors:

Update your Rust toolchain:

rustup update

Tauri development issues:

If the desktop application fails to start, try:

# Clean and rebuild
pnpm clean
pnpm install
pnpm run tauri dev

Node.js permissions:

Fix permission issues on macOS/Linux:

sudo chown -R $(whoami) ~/.local/share/pnpm

Getting Help

  1. Check Troubleshooting Guide for detailed solutions
  2. Review Development Workflow for development patterns
  3. Search project repository issues
  4. Create new issue with error details

Next Steps

After successful installation:

  1. Quick Start - Get the development environment running in 3 steps
  2. Development Workflow - Learn development patterns

Summary

GitInspectorGUI installation sets up Python analysis engine dependencies, React/TypeScript frontend tools, and Tauri desktop framework with PyO3 integration. The verification steps ensure all components work together correctly in a single process.