铸龙BI开源项目启动与配置教程
1. 项目的目录结构及介绍
铸龙BI开源项目的目录结构如下:
xwl_bi/
├── application/ # 应用层代码,包含业务逻辑处理
├── cmd/ # 主程序入口及命令行相关代码
├── config/ # 配置文件目录
├── controller/ # 控制器层代码,处理HTTP请求
├── engine/ # 内核代码,主要包括数据处理逻辑
├── middleware/ # 中间件目录,处理请求前后的逻辑
├── model/ # 数据模型层代码,用于数据库操作
├── platform-basic-libs/ # 平台基础库
├── router/ # 路由配置文件
├── sdk/ # SDK相关代码
├── views/ # 视图层代码,主要包含前端页面
├── vue/ # 前端Vue代码目录
├── .eslintignore # ESLint忽略文件
├── .gitignore # Git忽略文件
├── LICENSE # 开源协议文件
├── README.md # 项目说明文件
├── build_all_linux.bat # Linux环境下的构建脚本
├── build_all_mac.bat # macOS环境下的构建脚本
├── build_all_win.bat # Windows环境下的构建脚本
├── build_init_app_linux.bat # Linux环境下初始化应用的构建脚本
├── build_manager_linux.bat # Linux环境下管理应用的构建脚本
├── build_report_linux.bat # Linux环境下报表构建脚本
├── build_sinker_linux.bat # Linux环境下数据下沉构建脚本
├── go.mod # Go依赖管理文件
├── go.sum # Go依赖校验文件
├── init_app_start.bat # 应用初始化启动脚本
├── manager_start.bat # 管理端启动脚本
├── report_start.bat # 报表启动脚本
├── sinker_start.bat # 数据下沉启动脚本
└── vue_start.bat # 前端Vue启动脚本
2. 项目的启动文件介绍
项目的启动文件主要集中在 cmd
目录下,以下是主要的启动文件:
init_app_start.bat
: 在Windows环境下用于初始化应用的启动脚本。manager_start.bat
: 在Windows环境下用于启动管理端的脚本。report_start.bat
: 在Windows环境下用于启动报表的脚本。sinker_start.bat
: 在Windows环境下用于启动数据下沉的脚本。vue_start.bat
: 在Windows环境下用于启动前端Vue的脚本。
对于Linux和macOS环境,有对应的 .bat
文件替换为 .sh
脚本,功能类似。
3. 项目的配置文件介绍
项目的配置文件位于 config
目录下,以下是主要的配置文件:
config.yaml
: 包含项目的基本配置,如数据库连接信息、中间件配置等。router.yaml
: 包含项目路由的配置信息。- 其他配置文件: 根据不同的模块可能还有其他的配置文件,用于配置各模块的特定参数。
在启动项目之前,需要根据实际情况修改 config.yaml
中的配置信息,确保项目能够正确连接到数据库和中间件。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考