Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hughsk/colony
:chart_with_upwards_trend: In-browser network graphs representing the links between your Node.js code and its dependencies.
https://github.com/hughsk/colony
Last synced: 7 days ago
JSON representation
:chart_with_upwards_trend: In-browser network graphs representing the links between your Node.js code and its dependencies.
- Host: GitHub
- URL: https://github.com/hughsk/colony
- Owner: hughsk
- License: other
- Created: 2012-10-14T12:10:49.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2018-06-15T17:49:17.000Z (over 6 years ago)
- Last Synced: 2024-04-25T17:21:45.115Z (7 months ago)
- Language: JavaScript
- Homepage: http://hughsk.github.com/colony
- Size: 683 KB
- Stars: 519
- Watchers: 25
- Forks: 59
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - hughsk/colony - :chart_with_upwards_trend: In-browser network graphs representing the links between your Node.js code and its dependencies. (others)
README
# colony
In-browser graphs representing the links between your Node.js code and its
dependencies.
## Installation
``` bash
$ [sudo] npm install -g colony
```
## Quick Start
``` bash
# 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:
``` bash
$ 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](http://npm.im/serve), [NGINX](http://nginx.org) or plain old
[Apache](http://apache.org/).
For convenience, you can download and visualise any combination of NPM modules
too:
``` bash
$ colony --npm forever --npm component --npm browserify -o colony-npm
```
## Development
Clone the repository from Github and install the development dependencies:
``` bash
$ git clone git://github.com/hughsk/colony.git
$ cd colony
$ npm install
```
To rebuild/minify the client-side code, run `npm run-script prepublish`.