Project architecture visualization tool
-
Install the dependency
npm install --save-dev @archsense/orakul-starter -
Configure npm script
{
...
"scripts": {
...
"orakul": "npx orakul nestjs -p <path-to-root-folder>",
...
},
}- At the root of your project create the configuration file
scout.jsonwith the following properties:
{
"id": "<project/domain-id>",
"src": "<path-to-src-folder | microservices>",
"include": [
"<list-of-folders-in-src-to-include-optional>"
],
"exclude": [
"<list-of-folders-in-src-to-exclude-optional>"
]
}- Configure npm script
{
...
"scripts": {
...
"orakul": "npx orakul nestjs -c <path-to-config-folder>",
...
},
}- Go to http://localhost:4501 to see the visualization
- Just CLI command - no additional code required
- Support of NestJs microservices
- Different levels of visualizations: modules level and low level
- See only what you are interested in