Commit 7dcaa541 authored by fenghen777's avatar fenghen777

docs: docs目录文档全部改为中文命名, skill新增中文命名规则

- design.md → 设计文档.md
- introduction.md → 功能介绍.md
- openmodelica-export-analysis.md → Modelica导出分析.md
- eplan-visualizer skill新增规则: docs/目录文档必须使用中文命名
parent a620f441
...@@ -6,7 +6,7 @@ description: EPLAN Visualizer 项目总览 - 技术栈、目录结构、编码 ...@@ -6,7 +6,7 @@ description: EPLAN Visualizer 项目总览 - 技术栈、目录结构、编码
# EPLAN Visualizer 项目总览 # EPLAN Visualizer 项目总览
> 面向工业仿真的可视化原理图编辑与 Modelica 模型导出前端系统 > 面向工业仿真的可视化原理图编辑与 Modelica 模型导出前端系统
> 设计文档:`docs/design.md` > 设计文档:`docs/设计文档.md`
## 技术栈(勿擅自升级) ## 技术栈(勿擅自升级)
...@@ -51,7 +51,8 @@ src/ ...@@ -51,7 +51,8 @@ src/
3. **禁止**`utils/` 中引入 React 依赖 3. **禁止**`utils/` 中引入 React 依赖
4. 新增功能**优先创建新文件**,避免修改已稳定的核心文件 4. 新增功能**优先创建新文件**,避免修改已稳定的核心文件
5. 大改动优先新增类/文件,而非修改现有文件 5. 大改动优先新增类/文件,而非修改现有文件
6. 禁止自动提交 Git 6. `docs/` 目录下所有文档**必须使用中文命名**
7. 禁止自动提交 Git
## 编译验证 ## 编译验证
......
# SimuFlow (eplanvisualizer) 项目部署文档
## 项目信息
| 项目 | 说明 |
|------|------|
| 项目名称 | SimuFlow (eplan_gui) |
| 技术栈 | Vite 7 + React 19 + @xyflow/react + zustand |
| 服务器 | ubuntu@175.27.249.95 (Ubuntu 22.04 LTS) |
| 项目路径 | `/home/ubuntu/code/eplanvisualizer` |
| 访问地址 | http://175.27.249.95 |
| 部署方式 | nginx 托管静态文件 (80端口) |
| 部署日期 | 2026-03-14 |
---
## 一、环境准备
### 1.1 安装 nvm
```bash
# 使用 gitee 镜像(国内服务器推荐)
curl -o- https://gitee.com/mirrors/nvm/raw/v0.40.1/install.sh | bash
# 加载 nvm(安装后首次使用需要执行)
source ~/.nvm/nvm.sh
```
### 1.2 安装 Node.js
```bash
# 安装 LTS 版本
nvm install --lts
# 验证安装
node --version # v24.14.0
npm --version # 11.9.0
```
---
## 二、项目构建
```bash
cd /home/ubuntu/code/eplanvisualizer
# 安装依赖
npm install
# 构建生产版本(输出到 dist/ 目录)
npm run build
```
构建成功后会在项目根目录生成 `dist/` 文件夹,包含所有静态资源。
---
## 三、nginx 配置
### 3.1 安装 nginx
```bash
sudo apt-get update
sudo apt-get install -y nginx
```
### 3.2 创建站点配置
创建配置文件 `/etc/nginx/sites-available/eplanvisualizer`
```nginx
server {
listen 80;
server_name _;
root /home/ubuntu/code/eplanvisualizer/dist;
index index.html;
location / {
try_files $uri $uri/ /index.html;
}
location ~* \.(js|css|png|jpg|jpeg|gif|ico|svg|woff|woff2|ttf|eot)$ {
expires 30d;
add_header Cache-Control "public, immutable";
}
gzip on;
gzip_types text/plain text/css application/json application/javascript text/xml;
}
```
### 3.3 启用站点
```bash
# 创建软链接启用站点
sudo ln -sf /etc/nginx/sites-available/eplanvisualizer /etc/nginx/sites-enabled/
# 删除默认站点(避免冲突)
sudo rm -f /etc/nginx/sites-enabled/default
# 测试配置
sudo nginx -t
# 重启 nginx
sudo systemctl restart nginx
```
### 3.4 修复目录权限
nginx 以 `www-data` 用户运行,需要确保整个路径链可访问:
```bash
sudo chmod +x /home/ubuntu
sudo chmod +x /home/ubuntu/code
sudo chmod +x /home/ubuntu/code/eplanvisualizer
sudo chmod -R 755 /home/ubuntu/code/eplanvisualizer/dist
```
---
## 四、服务管理
```bash
# 查看 nginx 状态
sudo systemctl status nginx
# 重启 nginx
sudo systemctl restart nginx
# 停止 nginx
sudo systemctl stop nginx
# 设置开机自启(安装时已默认启用)
sudo systemctl enable nginx
```
---
## 五、更新部署
当代码更新后,执行以下步骤重新部署:
```bash
# 1. 进入项目目录
cd /home/ubuntu/code/eplanvisualizer
# 2. 加载 nvm
source ~/.nvm/nvm.sh
# 3. 拉取最新代码(如果使用 git)
# git pull
# 4. 安装依赖(如有新增)
npm install
# 5. 重新构建
npm run build
# 6. 权限修复(如果 dist 被重建)
sudo chmod -R 755 dist/
# nginx 无需重启,静态文件更新后直接生效
```
---
## 六、故障排查
### 查看 nginx 错误日志
```bash
sudo tail -50 /var/log/nginx/error.log
```
### 常见问题
| 问题 | 原因 | 解决方案 |
|------|------|----------|
| 500 Internal Server Error | `www-data` 无权访问 dist 目录 | 执行第 3.4 节的权限修复命令 |
| 502 Bad Gateway | nginx 未正确启动 | `sudo systemctl restart nginx` |
| 页面空白/404 | dist 目录为空或构建失败 | 重新执行 `npm run build` |
| nvm: command not found | SSH 非交互 shell 未加载 nvm | 先执行 `source ~/.nvm/nvm.sh` |
---
## 七、服务器信息
| 项目 | 值 |
|------|------|
| IP | 175.27.249.95 |
| 用户 | ubuntu |
| 操作系统 | Ubuntu 22.04 LTS |
| 内核 | 5.15.0-164-generic |
| nginx 版本 | 1.18.0 |
| Node.js 版本 | v24.14.0 |
| npm 版本 | 11.9.0 |
| nvm 版本 | 0.40.1 |
# ⚡ SimuFlow — 可视化仿真流程编辑器
一款基于 Web 的可视化流程搭建工具,支持拖拽式原理图设计与仿真建模。
## 核心功能
- 🧩 **丰富符号库** — 内置流程逻辑、电气控制、PLC、液压等 40+ 组件
- 🔀 **流程搭建** — 支持逻辑运算(大于/小于/与/或/非)、条件选择(Switch)、数值输入等流程节点,可自由组合搭建仿真流程
- 🖱️ **拖拽连线** — 从符号库拖出组件,通过端口连线快速搭建系统
- ✏️ **实时编辑** — 选中即可修改参数、名称、颜色、端口
- 🎨 **自定义符号** — 内置符号可编辑,也可创建全新符号模板
- 📤 **多格式导出** — 支持 JSON 保存/恢复、Modelica (.mo) 仿真模型导出、EPLAN 连接表导入
## 🌐 在线体验
**http://175.27.249.95/**
浏览器直接打开,无需安装,欢迎试用反馈!🙌
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment