Git Product home page Git Product logo

colony's Introduction

colony

In-browser graphs representing the links between your Node.js code and its dependencies.

Colony

Installation

$ [sudo] npm install -g colony

Quick Start

# Install colony and serve
$ [sudo] npm install -g serve colony
# Download and visualise "browserify" from NPM
$ colony --npm browserify && serve colony
# Open localhost:3000 in your web browser
$ open http://localhost:3000/

Using the Command-Line Interface

Usage: colony {files} --npm {modules}

Options:
  -o, --outdir   Output files to a particular folder                                     [default: "./colony"]
  -m, --modules  Traverse node_modules for more code. Use --no-modules to disable.       [default: true]
  -s, --scale    Scales the output graph by a specific size.                             [default: 1]
  -n, --npm      Download and process an NPM module instead of a local file.
  -t, --title    Change the title of the page
  -r, --readme   Readme file. By default will try to guess the first file's readme.
  -j, --json     Output the scripts' data as JSON, instead of generating and writing HTML
  -f, --fork     "Fork me on Github" button, e.g. "hughsk/colony". Hidden by default.
  -h, --help     Display this message

The simplest way to use colony from the command-line would be:

$ colony app.js -o colony

This will traverse app.js's dependencies and dump the necessary static HTML/CSS/JS files to the ./colony directory, this page being ./colony/index.html. Then it's just a matter of serving it up using something like serve, NGINX or plain old Apache.

For convenience, you can download and visualise any combination of NPM modules too:

$ colony --npm forever --npm component --npm browserify -o colony-npm

Development

Clone the repository from Github and install the development dependencies:

$ git clone git://github.com/hughsk/colony.git
$ cd colony
$ npm install

To rebuild/minify the client-side code, run npm run-script prepublish.

colony's People

Contributors

hughsk avatar

Watchers

James Cloos 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.