bron

<p align="center">
<img src="https://raw.githubusercontent.com/gophergala/bron/master/images/bron.jpg">
</p>

This hack was written by @defermat and @schvin as a submission in the first Gopher Gala over the weekend of 24-25 January, 2015. Please give it a whirl and let us know what you think.

Analysis of large source code repositories is always interesting, especially over long periods of time. Fun and useful to see various characteristics by language, who was actively contributing in a project, or when activity peaked. After coming across blessed, we knew we had a quick way visualize the analysis with no fuss or complications.

Target audience is other developers or consumers of development projects. Easy to glean more information about a project by looking at the source from a high-level viewpoint.

Visuals

Quick screencast demo and walkthrough is available here on Youtube:

<p align="center">
<a href="https://www.youtube.com/watch?v=Qkkf3s6k_-M"><img src="https://raw.githubusercontent.com/gophergala/bron/master/images/bron-animated.gif" border="0"></a>
</p>

Screenshot of the --viz=true output from the GitHub/Hub repository:

<p align="center">
<a href="https://raw.githubusercontent.com/gophergala/bron/master/images/bron-github-hub-gophergala-output.png"><img src="https://raw.githubusercontent.com/gophergala/bron/master/images/bron-github-hub-gophergala-output.png" border="0"></a>
</p>

Similarly from the Docker/Docker repository:

<p align="center">
<a href="https://raw.githubusercontent.com/gophergala/bron/master/images/bron-docker-docker-gophergala-output.png"><img src="https://raw.githubusercontent.com/gophergala/bron/master/images/bron-docker-docker-gophergala-output.png" border="0"></a>
</p>

Dependencies for manual installation

git

If using the -viz option, you'll need to have blessed-contrib installed. bron expects the blessed-contrib src directory to be a cousin to the bron src directory.

For example if your bron src directory is located at:

/go/src/github.com/gophergala/bron

Then your blessed-contrib src directory should be located somewhere like this:

/go/src/github.com/yaronn/blessed-contrib

After installing blessed-contrib be sure and copy over the dashboards directory from bron like so:

cp -R dashboards ../../yaronn/blessed-contrib/

Automated installation methods

Run on Nitrous:

Run on Docker:

Note, the Docker image (from the Hub or from source) will already include all of the above mentioned dependencies, so you can skip those steps.

Get it from the Docker Hub:

docker pull tubesandlube/bron
docker run -it bron -h

Or, build it yourself:

git clone https://github.com/gophergala/bron.git
cd bron
docker build -t bron .
docker run -it bron -h

Install using Go:

go get github.com/gophergala/bron
bron -h

Using Docker volumes to persist results

docker run -it -v /home/go/src/github/gophergala/bron/db:/go/src/github.com/gophergala/bron/db bron -viz