TDengineGUI 开源项目教程

1. 项目目录结构及介绍

TDengineGUI 的目录结构如下：

├── build/icons            # 存放图标资源
├── datatest               # 测试数据相关的文件夹
├── gitignore              # Git 忽略文件列表
├── LICENSE.md             # 许可证文件
├── main.js                # 应用主进程文件
├── package-lock.json      # npm 包锁定文件
├── package.json           # npm 包配置文件
├── preload.js             # 用于 Electron 的预加载脚本
├── README.md              # 项目说明文件
└── renderer                # 渲染进程代码所在的目录
   ├── ...                 # 渲染进程相关的各种子文件和目录

• main.js: 应用程序的主要入口点，负责初始化Electron环境并控制应用程序的行为。
• package.json: 存储项目依赖项和其他元数据，用于npm包管理和启动脚本。
• preload.js: 在渲染器进程中运行的脚本，用于安全地在Node.js和浏览器环境中共享数据。
• renderer 目录: 包含所有用户界面相关的代码，包括HTML、CSS和JavaScript。

2. 项目启动文件介绍

启动TDengineGUI的过程涉及到两个主要的启动文件：main.js 和 package.json 中的脚本。

• main.js: 这是Electron应用的核心文件。它创建并管理Electron的主进程，包括窗口实例、事件监听以及数据库连接逻辑。例如，它可能包含如下内容：

  const { app, BrowserWindow } = require('electron')
  const path = require('path')
  
  function createWindow() {
    // 创建浏览器窗口
    const mainWindow = new BrowserWindow({
      width: 800,
      height: 600,
      webPreferences: {
        nodeIntegration: true
      }
    })
  
    // 加载应用的index.html
    mainWindow.loadFile(path.join(__dirname, 'index.html'))
  
    // ...
  }
  
  // 当 Electron 已完成初始化并且可以创建浏览器窗口时，
  // 这个事件会被触发。
  app.on('ready', createWindow)
  

• package.json 的启动脚本：在命令行中，你可以使用以下命令来启动项目：

  npm run start
  

  这会在scripts对象中定义的start指令对应的操作，通常是启动开发服务器或者打包后的应用。

3. 项目配置文件介绍

TDengineGUI 项目本身没有独立的配置文件，但可以通过修改package.json来设置npm脚本或其他自定义配置。例如，如果你想自定义构建过程，可以在scripts部分增加一个新的脚本：

{
  "name": "tdenginge-gui",
  "version": "1.0.0",
  "scripts": {
    "start": "electron .",
    "build": "electron-packager . TDengineGUI --platform=win32 --arch=x64"
  },
  // ...
}

在这个例子中，build脚本使用了electron-packager来构建Windows 64位的应用包。要运行这个脚本，使用命令npm run build。

对于实际连接TDengine数据库的配置，它们通常是在运行时通过用户输入(如IP地址、端口、用户名和密码)提供的，而不是硬编码在配置文件中。

请根据这些信息自行调整配置，以便适配你的具体需求。