Just replace hub
with summarize
in any GitHub URL to generate a live, interactive documentation hub.
GitSummarize analyzes any GitHub repo (public or private) and generates:
- 📄 System-level architecture overviews
- 📁 Per-directory and file summaries
- 🧠 Natural language descriptions of purpose, flow, and structure
- 🔗 Business Logic and Rules Extraction
- 📊 Architecture diagrams and flows
It’s perfect for onboarding, exploring unfamiliar codebases, and writing technical documentation — all powered by Gemini.
Area | Stack |
---|---|
Frontend | Next.js, TypeScript, Tailwind CSS, ShadCN |
Backend | FastAPI, Python, Server Actions |
Database | PostgreSQL (Supabase) |
AI | Gemini 2.5 Pro |
Analytics | PostHog |
Hosting | Vercel (Frontend), Render (Backend) |
We wanted to contribute to open-source projects but found it difficult to understand massive codebases quickly.
GitSummarize automates the hardest part: figuring out what the code does and how it's structured — giving you useful documentation and high level overview of the codebase.
-
Clone the repo
git clone https://github.com/antarixxx/gitsummarize cd gitsummarize
-
Run the Next.js Project
npm run dev
You can now access the website at
localhost:3000
.
Contributions are welcome! Please feel free to submit a Pull Request.
Shoutout to GitIngest and GitDiagram for the inspiration and styling.
We are currently hosting it for free with rate limits though this is somewhat likely to change in the future based on Gemini's API policies.
- Expand documentation to cover more topics (Setup, Onboarding Guide)
- Add Architecture Diagrams