1.0.1 • Published 1 year ago

nestjs-graph v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Description

module for drawing depednecy graph of Nestjs modules and serving it using static contents.

Installation

$ npm i --save-dev nestjs-graph

Quick Start

main.ts:

import { NestFactory } from "@nestjs/core";
import { AppModule } from "./app.module";
import { GraphModule } from "nestjs-graph";

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  new GraphModule(app).serve("/graph", app.getHttpAdapter());
  await app.listen(3000);
}
bootstrap();

this code will draw dependency graph using mermaid-js on /graph. You can chnage it depending on your situation.

alt

This is the dependency graph of nestjs cat sample

Future work

  • add functionality to customize html contents.
  • add interactive and detailed contents in graph