Skip to content

Repository files navigation

🟢 CyberGit Report

[ English | 中文说明 ]

License React TypeScript Tailwind Gemini

"Wake up, Coder. We have a repo to analyze."

⚡ System Overview

CyberGit Report is an immersive, cyberpunk-themed GitHub annual report generator. It visualizes your coding journey through a sci-fi terminal interface, turning raw GitHub GraphQL data into a stunning "Netrunner" dossier.

Unlike standard reports, this system utilizes AI to psychoanalyze your coding style, assigning you a persona (e.g., "Fullstack AI Geek", "Refactor Monk") based on your languages, commit habits, and project topics.

Login

Report

Preview URL: Amery2010's CyberGit Report

📊 Report Intelligence

CyberGit aggregates disparate data points into a cohesive narrative:

  • Identity Matrix: Level calculation based on total contribution volume.
  • Temporal Analysis:
    • Chronotype: Peak productivity hours (e.g., "Night Owl" vs "Early Bird").
    • Rhythm: 24-hour activity distribution and contribution streaks.
  • Code Dynamics:
    • Entropy: Refactor ratio (Lines Added vs. Deleted).
    • Velocity: Average PR merge time and code churn magnitude.
  • Ecosystem:
    • Stack: Top languages by usage percentage.
    • Impact: Total Stars/Forks and Open Source contribution ratio.
    • Network: Organization affiliations and "Impact Star" repositories.
  • AI Psych Profile: A unique, generative text analysis of your coding personality.

💾 Core Modules

  • Cyberpunk UI/UX: Matrix rain canvas effects, CRT scanlines, neon glows, and immersive audio SFX (typing, hovering, booting).
  • Deep Data Analysis: Backend logic to calculate streaks, refactor ratios, and merge velocities from raw GraphQL nodes.
  • AI Persona Generation: Uses Google Gemini to generate a unique narrative profile describing your coding soul.
  • Contribution Heatmap: A dynamic, glowing activity grid auto-detected from your report year.
  • 3D Tech Cloud: Interactive tag sphere visualizing your top topics.
  • Export & Share: Generate a high-quality PNG snapshot of your report or share via a unique uplink URL.

🛠️ Tech Stack

  • Frontend: React 19, TypeScript
  • Styling: Tailwind CSS (with custom animations and fonts)
  • Data Fetching: GitHub GraphQL API
  • AI: Google GenAI SDK (@google/genai) + OpenAI-Compatible Chat Completions API
  • Audio: Web Audio API (Custom oscillator synthesizer)

🔌 Installation & Access

Prerequisites

  • Node.js (v18+)
  • A GitHub Personal Access Token (Scope: read:user, read:org, repo)
  • (Optional) Google Gemini API Key for AI features
  • (Optional) Any OpenAI-compatible API endpoint and key

Local Deployment

  1. Clone the Repository

    git clone https://github.com/Amery2010/cybergit.git
    cd cybergit
  2. Install Dependencies

    npm install
  3. Environment Setup Create a .env file in the root directory:

    # Optional: For local AI generation without proxy
    VITE_GEMINI_API_KEY=your_gemini_api_key_here
    
    # Optional: Any OpenAI-compatible API (Chat Completions)
    # Examples: OpenAI, Azure OpenAI-compatible gateway, vLLM, OneAPI, LocalAI, etc.
    VITE_OPENAI_API_BASE_URL=https://api.openai.com
    VITE_OPENAI_API_PATH=/v1/chat/completions
    VITE_OPENAI_API_KEY=your_openai_compatible_api_key_here
    VITE_OPENAI_MODEL=gpt-4o-mini
    # Optional org header
    # VITE_OPENAI_ORG=org_xxx
  4. Initiate System

    npm start

🕹️ Usage Guide

  1. Login: Enter your GitHub Personal Access Token.
    • Demo Mode: Click "BYPASS SECURITY" to view a mock profile (CyberRunner_2077).
  2. Visualization: Scroll through your dossier. The interface reveals data using scroll-triggered animations.
  3. Audio: Toggle the sound icon in the header to enable/disable UI sound effects.
  4. Language: Toggle between EN (English) and 中文 (Chinese).
  5. Snapshot: Click the camera icon at the bottom to download a PNG report.

⚠️ Privacy Protocol

This application runs entirely on the client-side (or via a stateless proxy). Your GitHub Token is never stored in any database.

  • Local Usage: Token resides in React state/memory.
  • Sharing: When sharing a report, a snapshot of the data (not the token) is temporarily cached.

📜 License

MIT © 2025 CyberGit Systems.


*System Analysis Complete. End of Line.*

About

Generate annual user reports using GitHub data.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages