Skip to content

siggy/gographs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

96 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gographs

gographs Go Report Card

gographs renders dependency graphs for Go packages.

gographs dependency example

Badge Markdown

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

Example

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

HTTP Endpoints

Endpoint Desc
/ Defaults to rendering this Go repo.
/repo/GO_REPO?cluster=false|true Permalink to a repo. Use POST to refresh.
/graph/GO_REPO.svg?cluster=false|true SVG direct link. Use POST to refresh.
/graph/GO_REPO.dot?cluster=false|true GraphViz DOT direct link. Use POST to refresh.
/svg?url=SVG_URL Permalink to view an arbitrary SVG URL.

Local dev

First-time setup

go install github.com/loov/goda@v0.4.3
brew install dot # or equivalent
brew install redis # or equivalent
redis-server /usr/local/etc/redis.conf

Boot server

go run main.go --log-level debug

Browse to http://localhost:8888

Lint check

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:

pkg/repo is based on Go Report Card

gographs courtesy of shields.io