AI-powered documentation for any GitHub repository. Just add "quick" to any GitHub URL.
github.com/vercel/next.js ā quickgithub.com/vercel/next.js
š Try it now: quickgithub.com
Paste any public GitHub repo URL and get a beautiful, multi-page documentation site in under 60 seconds:
- System Overview ā what the project does, key features, getting started
- Architecture ā component diagrams, data flow, Mermaid diagrams
- Tech Stack ā languages, frameworks, databases, tools
- Key Modules ā per-directory documentation with source file links
- Entry Points ā main files, CLI commands, API endpoints
- Dependencies ā categorized runtime and dev dependencies
- Setup Guide ā prerequisites, installation, configuration, running, testing
- Q&A Chat ā ask questions about the repo, powered by Claude Haiku
Already-indexed repos are served instantly from cache.
Browser ā Caddy (reverse proxy, auto-HTTPS)
ā Next.js 15 (App Router, NextAuth, SSE, API routes)
ā Redis 7 (cache + job queue + rate limits)
ā Go Worker (asynq job processor)
ā GitHub API (fetch repo tree + files)
ā Tree-sitter (parse source code)
ā Claude API (generate documentation)
ā PostgreSQL 16 (users, repos, docs, chat)
| Component | Technology |
|---|---|
| Frontend | Next.js 15, TypeScript, Tailwind CSS, shadcn/ui |
| Auth | NextAuth.js v5 (GitHub OAuth) |
| Backend API | Next.js API Routes |
| Worker | Go, asynq (Redis-backed job queue) |
| Code Parsing | Tree-sitter (multi-language) |
| LLM | Claude Sonnet 4.5 + Haiku 4.5 (Anthropic API) |
| Database | PostgreSQL 16 (Prisma ORM) |
| Cache/Queue | Redis 7 |
| Reverse Proxy | Caddy (auto-HTTPS) |
quickgithub/
āāā web/ # Next.js frontend + API
ā āāā prisma/ # Database schema
ā āāā src/
ā ā āāā app/ # App Router pages + API routes
ā ā āāā components/ # React components (docs/, chat/, ui/)
ā ā āāā lib/ # Prisma, Redis, auth, rate limiting
ā ā āāā hooks/ # SSE + chat hooks
ā ā āāā types/ # TypeScript interfaces
ā āāā package.json
āāā worker/ # Go background worker
ā āāā cmd/worker/ # Entry point
ā āāā internal/
ā ā āāā tasks/ # Job handler + types
ā ā āāā github/ # GitHub API client + file filtering
ā ā āāā parser/ # Tree-sitter parsing
ā ā āāā llm/ # Claude API client + pipeline
ā ā āāā notify/ # Email notifications (Resend)
ā ā āāā db/ # PostgreSQL client
ā ā āāā cache/ # Redis client
ā ā āāā config/ # Configuration
ā āāā go.mod
āāā docker-compose.yml # PostgreSQL + Redis
āāā Caddyfile
āāā Makefile
- Node.js 20+
- Go 1.22+
- Docker + Docker Compose
- GitHub OAuth app credentials
- Anthropic API key
docker-compose up -d
cd web cp .env.example .env # Fill in your credentials npm install npx prisma migrate dev npm run dev
cd worker cp .env.example .env # Fill in your credentials go run cmd/worker/main.go
See .env.example files in web/ and worker/ directories.
All rights reserved.