GitDiagram

Turn any GitHub repository into an interactive diagram for visualization in seconds.

You can also replace hub with diagram in any Github URL to access its diagram.

🚀 Features

👀 Instant Visualization: Convert any GitHub repository structure into a system design / architecture diagram
🎨 Interactivity: Click on components to navigate directly to source files and relevant directories
⚡ Fast Generation: Powered by OpenAI o4-mini for quick and accurate diagrams
🔄 Customization: Modify and regenerate diagrams with custom instructions
🌐 API Access: Public API available for integration (WIP)

⚙️ Tech Stack

Frontend: Next.js, TypeScript, Tailwind CSS, ShadCN
Backend: FastAPI, Python, Server Actions
Database: PostgreSQL (with Drizzle ORM)
AI: OpenAI o4-mini
Deployment: Vercel (Frontend), EC2 (Backend)
CI/CD: GitHub Actions
Analytics: PostHog, Api-Analytics

🤔 About

I created this because I wanted to contribute to open-source projects but quickly realized their codebases are too massive for me to dig through manually, so this helps me get started - but it's definitely got many more use cases!

Given any public (or private!) GitHub repository it generates diagrams in Mermaid.js with OpenAI's o4-mini! (Previously Claude 3.5 Sonnet)

I extract information from the file tree and README for details and interactivity (you can click components to be taken to relevant files and directories)

Most of what you might call the "processing" of this app is done with prompt engineering - see /backend/app/prompts.py. This basically extracts and pipelines data and analysis for a larger action workflow, ending in the diagram code.

🔒 How to diagram private repositories

You can simply click on "Private Repos" in the header and follow the instructions by providing a GitHub personal access token with the repo scope.

You can also self-host this app locally (backend separated as well!) with the steps below.

🛠️ Self-hosting / Local Development

Clone the repository

git clone https://github.com/ahmedkhaleel2004/gitdiagram.git
cd gitdiagram

Install dependencies

pnpm i

Set up environment variables (create .env)

cp .env.example .env

Then edit the .env file with your Anthropic API key and optional GitHub personal access token.

Run backend

docker-compose up --build -d

Logs available at docker-compose logs -f The FastAPI server will be available at localhost:8000

Start local database

chmod +x start-database.sh
./start-database.sh

When prompted to generate a random password, input yes. The Postgres database will start in a container at localhost:5432

Initialize the database schema

pnpm db:push

You can view and interact with the database using pnpm db:studio

Run Frontend

pnpm dev

You can now access the website at localhost:3000 and edit the rate limits defined in backend/app/routers/generate.py in the generate function decorator.

Contributing

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

Acknowledgements

Shoutout to Romain Courtois's Gitingest for inspiration and styling

📈 Rate Limits

I am currently hosting it for free with no rate limits though this is somewhat likely to change in the future.

🤔 Future Steps

Implement font-awesome icons in diagram
Implement an embedded feature like star-history.com but for diagrams. The diagram could also be updated progressively as commits are made.

Uh oh!

License

ahmedkhaleel2004/gitdiagram

ErrorLooks like something went wrong!

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Sponsor this project

Uh oh!

Uh oh!

Contributors 3

Languages

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!

Error
Looks like something went wrong!