https://github.com/dmanjunath/mapme
Visualize a node.js project's require tree
https://github.com/dmanjunath/mapme
Last synced: about 1 year ago
JSON representation
Visualize a node.js project's require tree
- Host: GitHub
- URL: https://github.com/dmanjunath/mapme
- Owner: dmanjunath
- Created: 2014-07-12T02:28:27.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-09-01T14:02:27.000Z (almost 12 years ago)
- Last Synced: 2025-03-03T00:04:12.650Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 2.66 MB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
mapme
=====
mapme is an npm module to help visualize an applications dependency structure with an easy to understand tree visualization. Simply run map me on the starting point of your app(eg app.js or server.js) and mapme will open an interactive d3 based tree showing you what your file dependencies are for your project.
#Getting Started
To install mapme, you can either:
install through npm
npm (-g) install mapme
or clone the source
#Running mapme
mapme takes two arguments
mapme path/to/file.js [outputFile.html OPTIONAL]
path/to/file.js is the entry point of your node.js app(like app.js usually). The path to the file can be relative if you have mapme installed globally, or absolute if you're calling mapme from the bin directory.
If you installed mapme locally as a npm module, you can find it in your project's
/node_modules/.bin/mapme
#Created By
Hareesh Nagaraj
Dheeraj Manjunath
#License
MIT