Turnilo 开源项目指南
1. 项目目录结构及介绍
Turnilo 是一个专为 Apache Druid 设计的数据探索和可视化Web应用程序。其目录结构如下:
.
├── README.md # 项目简介
├── config # 配置文件夹
│ └── example.yaml # 示例配置文件
├── src # 源代码主目录
│ ├── client # 前端应用程序代码
│ └── server # 后端服务代码
├── package.json # npm 包管理文件
└── package-lock.json # npm 包锁定文件,保证依赖一致性
config
: 存放项目配置文件,例如example.yaml
是一个配置示例。src/client
: 前端应用代码,负责用户界面和交互逻辑。src/server
: 后端服务代码,处理数据连接和API请求。package.json
和package-lock.json
: 用于Node.js的依赖管理和构建。
2. 项目启动文件介绍
Turnilo 的启动主要通过以下命令进行:
# 安装全局Turnilo分布
npm install -g turnilo
# 使用示例数据运行Turnilo
turnilo run-examples
# 或者,连接到现有的Druid集群
turnilo connect-druid <DRUID_BROKER_URL>
run-examples
: 这个命令将启动Turnilo并加载预设的示例数据集,可以在 http://localhost:9090/ 访问。connect-druid
: 用于指定Druid的代理地址,Turnilo会自动发现并加载可用的数据。
3. 项目的配置文件介绍
配置文件位于 config
目录下,默认是 example.yaml
,它定义了Turnilo的行为和连接到Druid的设置。这里是一些主要配置选项的例子:
clusterConfiguration:
druidHost: localhost # Druid集群的主机名或IP
druidPort: 8082 # Druid的HTTP接口端口
dataCubes:
- name: example_cube_name # 数据立方体名称
dataSource: example_source # Druid数据源名称
customization:
theme: default # 主题设置,可以自定义
可以根据实际需求修改这些参数,如更改Druid服务器的位置,添加数据立方体,以及调整UI主题等。
请注意,Turnilo项目使用的是YAML格式的配置文件,YAML是一种易读的配置语言,以缩进表示层级关系。
为了开始使用Turnilo,你可以复制 example.yaml
并根据你的环境进行必要的编辑,然后在启动时指定该配置文件。
更多详细的配置信息和选项,请参考官方文档或GitHub仓库中的相关文件和说明。