https://github.com/alsiola/nest-dependency-viewer
https://github.com/alsiola/nest-dependency-viewer
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/alsiola/nest-dependency-viewer
- Owner: alsiola
- Created: 2021-04-07T18:42:55.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-10-18T08:59:47.000Z (over 3 years ago)
- Last Synced: 2025-02-03T04:04:23.068Z (over 1 year ago)
- Language: TypeScript
- Size: 32.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nest-dependency-viewer
Provides a web UI for examining the dependency tree of a NestJS application. Intended to run in development environments, on a separate port from the main application.
Available from [NPM](https://www.npmjs.com/package/nest-dependency-viewer)
## Dependencies
This package requires [Java](https://java.com/en/download/) to be running, and [graphviz](http://www.graphviz.org/) to be installed.
## Usage
Install with your package manager of choice:
```
yarn add nest-dependency-viewer
```
Create your main application first, then pass it to `DependencyTreeViewer.create`:
```
// Your app setup
const app = await NestFactory.create(AppModule);
// Provide create method with the app to be examined, and the port on which *the dependency viewer* will be served
const dependencyTreeViewerApp = await DependencyTreeViewer.create(app, 5001);
// Start the viewer
await dependencyTreeViewerApp.start(5001);
```