ondrajz / goexplorer

Interactive overview of Go packages using dynamic visualization.

Go Explorer

Go Explorer is an experimental tool to dynamically visualize Go packages using interactive overview.

---

Introduction

Goal of this project is to experiment with visualization of Go packages and environment to aid developers by providing interactive overviews for various analyses, such as exploring package hierarchy, viewing package dependencies, examining call graph of a program, ..etc.

The initial idea began during development of go-callvis and I've decided to develop goexplorer as a separate project, which is intended to provide more abstract approach.

Preview

How it works

It has web server that serves the API and web application that uses vis.js for visualization inside <canvas>.

Features

This project is currently at very early stage of development! ⚠️

• explore hierarchy of $GOPATH
• view dependencies of a package
• examine call graph of a program

Installation

Requirements

• Go 1.7+

Install

Use the following command to install:

go get -u github.com/TrueFurby/goexplorer

Usage

Quick start

Start the web server with

cd $GOPATH/src/github.com/TrueFurby/goexplorer; go install
goexplorer

Open http://localhost:8888 in your browser.

Getting started

Clicking on nodes will retrieve content if any and add it's child nodes dynamically to the clicked node. By pressing DEL key you can remove all child nodes of currently selected node.

Nodes

• with green laptop icon represent programs
• with blue box icon represent packages

Community

Join the #goexplorer channel at gophers.slack.com (not a member? get invitation)

---

Did you find any bugs or have any suggestions? Feel free to open new issue or start discussion in the slack channel.

goexplorer's Issues

Instructions need an update

I do

% goexplorer -verbose
13:24:07.872890 serving at :8888

and go to http://127.0.0.1:8888/. All i get is a white page saying 404 page not found.

The tip of my cloned git is

commit 8762e267ae486aa438b7e42627e6a1bf14e000f1
Author: Ondrej Fabry <[email protected]>
Date:   Sun Apr 2 20:24:22 2017 +0200

    Set theme jekyll-theme-midnight

diff --git a/_config.yml b/_config.yml
index c419263..1885487 100644
--- a/_config.yml
+++ b/_config.yml
@@ -1 +1 @@
-theme: jekyll-theme-cayman
\ No newline at end of file
+theme: jekyll-theme-midnight
\ No newline at end of file

PageRank angorithm running on top of graph interface

The idea is to have an underlying graph interface which can be implemented by multiple possible datastructures e.g. CSR graph or HAMT graph or simple map based graph.
The algorithm therefore should only use the pre-defined functions(functionalities) under the graph interface to run the PageRank algorithm.

Size parameter in Node

Extend the definition of a Node by including size which will be calculated by PageRank depending on how important the Node is

Use PageRank in the code to generate the size output for nodes

This will just give an extra field in the pre-exisiting node.
Currently the full graph for rendering is generated in frontend as vis has system for it. Let's keep it as it is right now.

Create Graph Interface in Backend

This interface has to implement:

• PageRank
• Some common algorithms e.g. BFS, DFS, DIjkstra (in future)

这个会集成go-callvis吗