gitdiagram
Free, simple, fast interactive diagrams for any GitHub repository
File Explorer
Download Latest Version (.zip)- ci.yml
- dependabot.yml
- FUNDING.yml
- deployment-failover.md
- dev-setup.md
- readme_img.png
- minimatch@3.1.5.patch
- favicon.ico
- check-performance-budgets.mjs
- complimentary-quota-today.mjs
- dev-turbo.sh
- migrate-browse-index.ts
- loading.tsx
- opengraph-image.tsx
- page.tsx
- repo-page-client.test.tsx
- repo-page-client.tsx
- social-image.tsx
- twitter-image.tsx
- route.ts
- route.test.ts
- route.ts
- route.test.ts
- route.ts
- route.test.ts
- route.ts
- route.test.ts
- route.ts
- route.test.ts
- route.ts
- route.test.ts
- route.ts
- route.test.ts
- route.ts
- route.test.ts
- route.ts
- page.tsx
- page.tsx
- sponsor-email-actions.tsx
- layout.tsx
- opengraph-image.png
- page.tsx
- providers.test.tsx
- providers.tsx
- robots.ts
- sitemap.ts
- twitter-image.png
- github-icon.tsx
- button.tsx
- dialog.tsx
- input.tsx
- skeleton.tsx
- sonner.tsx
- switch.tsx
- tooltip.tsx
- api-key-dialog.tsx
- browse-catalog-controls.tsx
- browse-catalog-loading-state.tsx
- browse-catalog-results.tsx
- browse-catalog-shared.test.ts
- browse-catalog-shared.ts
- browse-catalog.test.tsx
- browse-catalog.tsx
- browse-diagram-preview.test.tsx
- browse-diagram-preview.tsx
- copy-button.test.tsx
- copy-button.tsx
- credential-dialogs.test.tsx
- export-dropdown.tsx
- footer.tsx
- generation-audit-panel.tsx
- header-client.tsx
- header.tsx
- hero.tsx
- loading.test.tsx
- loading.tsx
- main-card.test.tsx
- main-card.tsx
- mermaid-diagram-helpers.ts
- mermaid-diagram-toolbar.tsx
- mermaid-diagram.test.tsx
- mermaid-diagram.tsx
- private-repos-dialog.tsx
- sponsor-slot.tsx
- theme-toggle.tsx
- web-vitals.test.tsx
- web-vitals.tsx
- catalog.test.ts
- catalog.ts
- index-client.test.ts
- index-client.ts
- api.multitab.test.ts
- api.test.ts
- api.ts
- api.test.ts
- api.ts
- cost.ts
- export.test.ts
- export.ts
- github-url.test.ts
- github-url.ts
- graph.ts
- mermaid-security.test.ts
- mermaid-security.ts
- sse.test.ts
- sse.ts
- types.ts
- useDiagramExport.ts
- useDiagramStream.test.ts
- useDiagramStream.ts
- use-browse-hover-preview.ts
- use-credential-setting.ts
- use-hydrated.test.tsx
- use-hydrated.ts
- use-mermaid-viewport.test.tsx
- use-mermaid-viewport.ts
- useDiagram.test.ts
- useDiagram.ts
- useStarReminder.tsx
- analytics-client.ts
- exampleRepos.ts
- site.ts
- sitemaps.test.ts
- sitemaps.ts
- utils.ts
- cancellation.test.ts
- cancellation.ts
- complimentary-gate.test.ts
- complimentary-gate.ts
- cost-estimate.test.ts
- cost-estimate.ts
- errors.test.ts
- errors.ts
- final-cost.test.ts
- final-cost.ts
- format.ts
- generation-policy.ts
- github.test.ts
- github.ts
- graph-planner.ts
- graph.test.ts
- graph.ts
- mermaid-validator.ts
- mermaid.test.ts
- mermaid.ts
- model-config.test.ts
- model-config.ts
- openai.test.ts
- openai.ts
- pricing.test.ts
- pricing.ts
- prompts.ts
- rate-limit.test.ts
- rate-limit.ts
- request-admission.test.ts
- request-admission.ts
- session-audit.test.ts
- session-audit.ts
- sse-writer.test.ts
- sse-writer.ts
- stream-buffer.test.ts
- stream-buffer.ts
- stream-finalization.ts
- types.test.ts
- types.ts
- client-ip.test.ts
- client-ip.ts
- request-credentials.test.ts
- request-credentials.ts
- same-origin-json.test.ts
- same-origin-json.ts
- same-origin.test.ts
- same-origin.ts
- cards.tsx
- repo-metadata.test.ts
- repo-metadata.ts
- artifact-store.test.ts
- artifact-store.ts
- browse-diagrams.test.ts
- browse-diagrams.ts
- browse-index-pending.test.ts
- browse-index-pending.ts
- cache-key.test.ts
- cache-key.ts
- config.ts
- diagram-state.test.ts
- diagram-state.ts
- distributed-lock.test.ts
- distributed-lock.ts
- generation-persistence.test.ts
- generation-persistence.ts
- quota-store.redis.test.ts
- quota-store.test.ts
- quota-store.ts
- r2.ts
- repo-page-cache.ts
- status-store.ts
- types.ts
- upstash.ts
- browse-index-cache.test.ts
- browse-index-cache.ts
- github-auth.test.ts
- github-auth.ts
- github-stars.ts
- readiness.test.ts
- readiness.ts
- globals.css
- proxy.test.ts
- proxy.ts
- .dockerignore
- .env.example
- .gitignore
- .vercelignore
- bun.lock
- CLAUDE.md
- components.json
- Dockerfile
- eslint.config.mjs
- LICENSE
- next.config.js
- package.json
- postcss.config.js
- prettier.config.js
- railway.json
- README.md
- tailwind.config.ts
- tsconfig.json
- vercel.json
- vitest.config.ts
- vitest.setup.ts
๐ Installation Guide
1. Get the code
git clone https://github.com/ahmedkhaleel2004/gitdiagram
Downloads the entire project code from GitHub to your computer.
cd gitdiagram
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t gitdiagram .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 gitdiagram
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation
Was this content helpful?
(0 ratings)