Home

   ██████╗ ██╗████████╗██████╗  █████╗ ██╗   ██╗
  ██╔════╝ ██║╚══██╔══╝██╔══██╗██╔══██╗╚██╗ ██╔╝
  ██║  ███╗██║   ██║   ██████╔╝███████║ ╚████╔╝ 
  ██║   ██║██║   ██║   ██╔══██╗██╔══██║  ╚██╔╝  
  ╚██████╔╝██║   ██║   ██║  ██║██║  ██║   ██║   
   ╚═════╝ ╚═╝   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝   ╚═╝   
    Official Wiki of the GitRay Repository!

---

Welcome to GitRay Documentation

A professional Git visualization tool that transforms repository commit history into beautiful, interactive heatmaps and activity calendars. Built with performance and scalability in mind, GitRay provides deep insights into development patterns and team collaboration.

Table of Contents

• Getting Started
• Architecture Documentation
• Component Documentation
• Feature Documentation
• How to Use This Wiki

Getting Started

New to GitRay? Start here to understand the project structure and get up to speed quickly:

1. 📁 Folder structure from GitRay - Understanding the project layout
2. 🛠️ Structure of Technologies - Tech stack overview
3. 📝 Structure of Naming conventions - Code standards
4. 🧪 Structure of Unit Testing - Testing approach

Architecture Documentation

Understand the technical foundation and system design:

• Documentation structure of GitRay-Wiki - How this wiki is organized
• Structure of packages shared-types - Shared type definitions
• Structure of Frontend Configuration - Frontend setup
• Structure of Backend API - API design

Component Documentation

Deep dive into specific components and services:

• MainPage Component - Main application interface
• The root-config component - Application configuration
• Git Service - Git operations handler
• Error Handler Middleware - Error management

Feature Documentation

Learn about specific features and tools:

• Vitest Testing Framework - Testing implementation

How to Use This Wiki

• 🔍 Search: Use the search box above to find specific topics
• 📊 Diagrams: Most pages include UML diagrams for visual understanding
• 🏗️ Structure: Each component page follows a consistent format (Description → Implementation → Structure → UML Diagrams)
• 🔗 Navigation: Use the breadcrumb links to navigate back to sections

💡 Tip: Start with the Getting Started section if you're new to the project, or jump directly to specific components if you're looking for implementation details.