Transform any GitHub repository into beautiful, AI-powered interactive documentation in seconds.
GitDex leverages advanced AI to analyze your codebase, generate comprehensive documentation, and provide an interactive assistant that knows your project inside out.
- 🧠 Smart Analysis: AI-powered code analysis that understands project structure and generates deep architectural insights.
- 💬 AI Code Assistant: A built-in chat interface that allows you to ask questions about the codebase, find where things are implemented, and understand complex logic.
- 📊 Interactive Diagrams: Auto-generated Mermaid diagrams for visualizing system architecture, workflows, and data flows with pan/zoom support.
- 🔍 Seamless Integration: Enter any
owner/repoto instantly index and view documentation. - ⚡ Premium UI: A fast, responsive documentation viewer built with Next.js, Fumadocs, and sleek modern aesthetics.
- Framework: Next.js (App Router)
- Runtime: Bun
- Styling: Tailwind CSS
- UI Components: assistant-ui, Fumadocs, Lucide React
- Data Fetching: AI SDK with manual ReAct loop integration.
- Engine: Node.js & Express
- AI Model: Google Gemma-3 (via Google AI SDK)
- Tooling: Octokit for GitHub API interaction.
- Processing: BullMQ/Queue system for background repository indexing.
gitdex/
├── client/ # Next.js frontend application
│ ├── components/ # Core UI components (Chat, Modal, UI primitives)
│ ├── src/app/ # App Router pages and API routes
│ └── lib/ # Utility functions and stores
└── server/ # Node.js backend & API
├── controllers/ # Business logic for indexing and repos
├── routes/ # API endpoints
└── queue.js # Background job processing- Clone the repo
- Setup Client:
cd client bun install bun dev - Setup Server:
cd server bun install bun start - Environment Variables:
Ensure you have
GOOGLE_GENERATIVE_AI_API_KEYandGITHUB_TOKENconfigured in your environment.