@archsense/orakul-starter

Orakul

Project architecture visualization tool

How to use

Configure npm script for a project

1. Install the dependency npm install --save-dev @archsense/orakul-starter

2. Configure npm script

{
  ...
  "scripts": {
    ...
    "orakul": "npx orakul nestjs -p <path-to-root-folder>",
    ...
  }, 
}

Configuration file for monorepo

1. At the root of your project create the configuration file scout.json with 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>"
  ]
}

1. Configure npm script

{
  ...
  "scripts": {
    ...
    "orakul": "npx orakul nestjs -c <path-to-config-folder>",
    ...
  }, 
}

1. Go to http://localhost:4501 to see the visualization

Why Orakul

1. Just CLI command - no additional code required
2. Support of NestJs microservices
3. Different levels of visualizations: modules level and low level
4. See only what you are interested in