奥拉库尔

项目架构可视化工具

如何使用

为工程配置 npm 脚本

1. 安装依赖 npm install --save-dev @archsense/orakul-starter

2. 配置 npm 脚本

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

单曲配置文件

1. 创建配置文件 scout.json 具有下列属性:

{  
  "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>"
  ]
}

2. 配置 npm 脚本

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

3. 转到 http://localhost:4501 (英语) 要看到视觉

为什么奥拉库尔

1. 只有CLI命令 - 不需要额外的代码
2. 支持雀巢Js微型服务
3. 不同水平的可视化:模块水平和低水平
4. 只看你感兴趣的东西