Giter VIP home page Giter VIP logo

assetviz's Introduction

AssetViz

NPM version Dependency Status

Assetviz is a web application code base visualization tool. Generate a self encapsulated html-file with a force directed graph representing the assets in your project and their relations.

As an added bonus this also works with any web page url as well.

Example

Installation

npm install assetviz

If you get installation errors for node-canvas, don't despair. It's an optional dependency used by Assetgraph to do some other cool stuff that isn't used in AssetViz.

Usage

$ assetviz [-h] [-v] [-r /path/to/webroot] [-o output.html] /path/to/webroot/index.html
$ google-chrome assetviz.html

The command line tool outputs an html-file called assetviz.html in the current working directory.

Arguments:

  • Any number of html.files
  • A path, assetviz will look for index.html in that path
  • A minimatch pattern like path/to/webroot/**/*.html
  • An URL (yes, you read that right)

Parameters:

-h : Help

-o : Output. The file name to output to. - pipes to stdout. Defaults to ./assetviz.html if undefined.

-r : Root. Tells AssetViz which directory to treat as the web root. Only useful if you are graphing an html-file that has relations outside its own directory.

-v : Verbose. Includes inline assets in the output graph. If unset only inline elements relevant to describe file relations will be shown.

AssetViz output

The outputted graph html-file is called assetviz.html. It is a self contained file with no external dependencies, so you can upload it anywhere, email it or do whatever you want with it without worrying about dependencies or being online to view.

While viewing the graph you can use the mousewheel to zoom and click+drag to pan (google maps style navigation).

Future roadmap

  • Improve text rendering
  • Highlight relations on hover
  • Relation direction with arrow heads
  • Merge visualization template with grunt-dependencygraph

Thanks to

Andreas Lind Petersen for all his wonderful work on Assetgraph. We have barely scratched the surface of the potential this project has. Kenneth Auchenberg for his visualization work and revitalization of the source code visualization dream.

License

MIT

Bitdeli Badge

assetviz's People

Contributors

bitdeli-chef avatar munter avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.