10000 GitHub - antarixxx/gitsummarize: Get beautiful, world-class documentation for any repo
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

antarixxx/gitsummarize

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🧠 GitSummarize

Image

Generate beautiful, world-class documentation from any GitHub repository — instantly.

Just replace hub with summarize in any GitHub URL to generate a live, interactive documentation hub.

https://gitsummarize.com/


🚀 Features

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.


🧰 Tech Stack

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)

🤔 Why GitSummarize?

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.


🧪 Local Development / Self-Hosting

  1. Clone the repo

    git clone https://github.com/antarixxx/gitsummarize
    cd gitsummarize
  2. Run the Next.js Project

    npm run dev

    You can now access the website at localhost:3000.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Acknowledgements

Shoutout to GitIngest and GitDiagram for the inspiration and styling.

📈 Rate Limits

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.

🤔 Future Steps

  • Expand documentation to cover more topics (Setup, Onboarding Guide)
  • Add Architecture Diagrams

Star History

Star History Chart

About

Get beautiful, world-class documentation for any repo

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0