HMI Workspace 开源项目教程

HMI Workspace 开源项目教程

hmi-workspaceAn Workspace for HMI tools项目地址:https://gitcode.com/gh_mirrors/hm/hmi-workspace

项目目录结构及介绍

hmi-workspace/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── public/
│   │   ├── index.html
│   ├── components/
│   │   ├── Header.js
│   │   ├── Footer.js
│   ├── styles/
│   │   ├── main.css
├── tests/
│   ├── index.test.js

• README.md: 项目说明文件。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • public/: 公共资源目录。
    • index.html: 主页文件。
  • components/: 组件目录。
    • Header.js: 头部组件。
    • Footer.js: 底部组件。
  • styles/: 样式文件目录。
    • main.css: 主样式文件。
• tests/: 测试文件目录。
  • index.test.js: 入口文件测试。

项目启动文件介绍

项目启动文件为 src/index.js，该文件主要负责初始化应用和启动服务器。以下是 index.js 的简要介绍：

const express = require('express');
const app = express();
const config = require('./config');

app.use(express.static('public'));

app.get('/', (req, res) => {
  res.sendFile(__dirname + '/public/index.html');
});

const port = process.env.PORT || config.port;
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

• 引入依赖: 引入了 express 和 config 模块。
• 创建应用实例: 使用 express() 创建应用实例 app。
• 静态文件服务: 使用 express.static 中间件提供静态文件服务。
• 路由配置: 配置根路由 / 返回 index.html 文件。
• 启动服务器: 监听配置的端口，启动服务器。

项目配置文件介绍

项目配置文件位于 src/config/ 目录下，主要包括 default.json 和 production.json 两个文件。

default.json

{
  "port": 3000,
  "db": {
    "host": "localhost",
    "user": "root",
    "password": "",
    "database": "hmi"
  }
}

• port: 默认端口号。
• db: 数据库配置，包括主机、用户名、密码和数据库名。

production.json

{
  "port": 8080,
  "db": {
    "host": "production-db-host",
    "user": "prod_user",
    "password": "prod_password",
    "database": "hmi_prod"
  }
}

• port: 生产环境端口号。
• db: 生产环境数据库配置，包括主机、用户名、密码和数据库名。

配置文件通过 config 模块加载，根据环境变量选择相应的配置文件。

hmi-workspaceAn Workspace for HMI tools项目地址:https://gitcode.com/gh_mirrors/hm/hmi-workspace