https://github.com/siggy/gographs

Dependency graphs for Go packages.
https://github.com/siggy/gographs

dependency-graph golang graphviz svg

Last synced: 2 months ago
JSON representation

Dependency graphs for Go packages.

• Host: GitHub
• URL: https://github.com/siggy/gographs
• Owner: siggy
• License: mit
• Created: 2019-12-13T08:24:33.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-13T21:27:47.000Z (10 months ago)
• Last Synced: 2024-10-14T19:08:34.628Z (3 months ago)
• Topics: dependency-graph, golang, graphviz, svg
• Language: Go
• Homepage: https://gographs.io
• Size: 224 KB
• Stars: 50
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gographs

[![gographs](https://gographs.io/badge.svg)](https://gographs.io/repo/github.com/siggy/gographs?cluster=true)

[![Go Report Card](https://goreportcard.com/badge/github.com/siggy/gographs)](https://goreportcard.com/report/github.com/siggy/gographs)

[gographs](https://gographs.io) renders dependency graphs for Go packages.

[![gographs dependency example](https://gographs.io/graph/github.com/siggy/gographs.svg?cluster=true)](https://gographs.io)

## Badge Markdown

```md

[![gographs](https://gographs.io/badge.svg)](https://gographs.io/repo/GO_REPO?[cluster=true|false])

```

Example

```md

[![gographs](https://gographs.io/badge.svg)](https://gographs.io/repo/github.com/siggy/gographs?cluster=true)

```

## HTTP Endpoints

| Endpoint | Desc |

| --- | --- |

| [/](https://gographs.io) | Defaults to rendering this Go repo. |

| [/repo/GO_REPO?cluster=false\|true](https://gographs.io/repo/github.com/siggy/gographs?cluster=true) | Permalink to a repo. Use `POST` to refresh. |

| [/graph/GO_REPO.svg?cluster=false\|true](https://gographs.io/graph/github.com/siggy/gographs.svg?cluster=true) | SVG direct link. Use `POST` to refresh. |

| [/graph/GO_REPO.dot?cluster=false\|true](https://gographs.io/graph/github.com/siggy/gographs.dot?cluster=true) | GraphViz DOT direct link. Use `POST` to refresh. |

| [/svg?url=SVG_URL](https://gographs.io/svg?url=https://upload.wikimedia.org/wikipedia/commons/0/05/Go_Logo_Blue.svg) | Permalink to view an arbitrary SVG URL. |

## Local dev

### First-time setup

```bash

go install github.com/loov/[email protected]

brew install dot # or equivalent

brew install redis # or equivalent

redis-server /usr/local/etc/redis.conf

```

### Boot server

```bash

go run main.go --log-level debug

```

Browse to http://localhost:8888

## Lint check

```bash

bin/lint

```

## Credits

This tool is built using many open source packages, but two in particular

deserve special mention, as this site is essentially a mashup of them:

- [goda](https://github.com/loov/goda)

- [SVGPan](https://github.com/bumbu/svg-pan-zoom)

[`pkg/repo`](./pkg/repo) is based on [Go Report Card](https://github.com/gojp/goreportcard)

[![gographs](https://gographs.io/badge.svg)](https://gographs.io/repo/github.com/siggy/gographs?cluster=true) courtesy of [shields.io](https://shields.io/)