From 4f088a0c637dbaae78019cf245b3b0af3d4fc095 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Sat, 25 Jul 2026 09:24:25 +0000 Subject: [PATCH] Add README.md --- README.en.md | 149 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 151 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 300 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..d547ac5 --- /dev/null +++ b/README.en.md @@ -0,0 +1,149 @@ +# JVS SPC UI + +## Project Introduction + +JVS SPC UI is a Statistical Process Control (SPC) frontend application built based on Vue 3 + TypeScript + Vite. The application focuses on the industrial quality control field, providing complete data visualization, anomaly monitoring, inspection management, and other functions. + +## Technology Stack + +- **Framework**: Vue 3 +- **Language**: TypeScript +- **Build Tool**: Vite +- **Style**: SCSS +- **HTTP**: Axios +- **Icons**: Iconfont +- **Deployment**: Docker (Nginx) + +## Functional Modules + +### 1. SPC Workspace +- Product Tree Management +- Control Chart Analysis +- Data Import +- Exception List +- Message Configuration + +### 2. Exception Center +- Exception Dashboard +- Exception List +- Exception Details Drawer + +### 3. Inspection Management +- Inspection Forms + +### 4. System Management +- Message Templates +- System Configuration +- User Information Management + +### 5. Data Visualization +- Dashboard Pages +- Dynamic Page Design +- Component Design & Management + +## Quick Start + +### Environment Requirements + +- Node.js 16+ +- npm or yarn + +### Install Dependencies + +```bash +npm install +# or +yarn install +``` + +### Development Mode + +```bash +npm run dev +# or +yarn dev +``` + +### Build Production Version + +```bash +npm run build +# or +yarn build +``` + +### Docker Deployment + +```bash +# Build image +docker build -t jvs-spc-ui docker/ + +# Run container +docker run -d -p 80:80 jvs-spc-ui +``` + +## Project Structure + +``` +├── public/ # Static Resources +│ └── jvs-ui-public/ # JVS UI Public Resources +│ ├── icon/ # Icon Files +│ ├── fonts/ # Font Files +│ ├── img/ # Image Resources +│ └── cdn/ # CDN Resources +├── src/ +│ ├── api/ # API Interfaces +│ ├── components/ # Common Components +│ ├── const/ # Constant Definitions +│ ├── router/ # Route Configuration +│ ├── store/ # State Management +│ ├── styles/ # Style Files +│ ├── util/ # Utility Functions +│ ├── views/ # Page Views +│ ├── App.vue # Root Component +│ └── main.ts # Entry File +├── docker/ # Docker Configuration +├── index.html # HTML Entry +├── package.json # Project Configuration +├── vite.config.ts # Vite Configuration +└── tsconfig.json # TypeScript Configuration +``` + +## Configuration Instructions + +### API Configuration + +Configure basic request parameters in `src/api/request.ts`: + +```typescript +const instance: AxiosInstance +// Configure request interceptors and response interceptors +``` + +### Route Configuration + +Route files are located in `src/router/index.ts` and `src/router/page.ts` + +### Environment Variables + +Configure environment variables via `vite.config.ts` + +## Browser Support + +- Chrome (Recommended) +- Firefox +- Edge +- Safari + +## License + +This project is open source under the MIT License. + +## Contribution Guide + +Issues and Pull Requests are welcome. + +## Contact Information + +- Project Address: https://gitee.com/software-minister/jvs-spc-ui +- Issue Feedback: https://gitee.com/software-minister/jvs-spc-ui/issues \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..317b91b --- /dev/null +++ b/README.md @@ -0,0 +1,151 @@ + + +# JVS SPC UI + +## 项目简介 + +JVS SPC UI 是一个基于 Vue 3 + TypeScript + Vite 构建的统计过程控制（SPC）前端应用。该应用专注于工业质量管控领域，提供完整的数据可视化、异常监控、检验管理等功能。 + +## 技术栈 + +- **框架**: Vue 3 +- **语言**: TypeScript +- **构建工具**: Vite +- **样式**: SCSS +- **HTTP**: Axios +- **图标**: Iconfont +- **部署**: Docker (Nginx) + +## 功能模块 + +### 1. SPC工作台 +- 产品树管理 +- 控制图分析 +- 数据导入 +- 异常列表 +- 消息配置 + +### 2. 异常中心 +- 异常看板 +- 异常列表 +- 异常详情抽屉 + +### 3. 检验管理 +- 检验表单 + +### 4. 系统管理 +- 消息模板 +- 系统配置 +- 用户信息管理 + +### 5. 数据可视化 +- 看板页面 +- 动态页面设计 +- 组件设计与管理 + +## 快速开始 + +### 环境要求 + +- Node.js 16+ +- npm 或 yarn + +### 安装依赖 + +```bash +npm install +# 或 +yarn install +``` + +### 开发模式 + +```bash +npm run dev +# 或 +yarn dev +``` + +### 构建生产版本 + +```bash +npm run build +# 或 +yarn build +``` + +### Docker 部署 + +```bash +# 构建镜像 +docker build -t jvs-spc-ui docker/ + +# 运行容器 +docker run -d -p 80:80 jvs-spc-ui +``` + +## 项目结构 + +``` +├── public/ # 静态资源 +│ └── jvs-ui-public/ # JVS UI 公共资源 +│ ├── icon/ # 图标文件 +│ ├── fonts/ # 字体文件 +│ ├── img/ # 图片资源 +│ └── cdn/ # CDN资源 +├── src/ +│ ├── api/ # API接口 +│ ├── components/ # 公共组件 +│ ├── const/ # 常量定义 +│ ├── router/ # 路由配置 +│ ├── store/ # 状态管理 +│ ├── styles/ # 样式文件 +│ ├── util/ # 工具函数 +│ ├── views/ # 页面视图 +│ ├── App.vue # 根组件 +│ └── main.ts # 入口文件 +├── docker/ # Docker配置 +├── index.html # HTML入口 +├── package.json # 项目配置 +├── vite.config.ts # Vite配置 +└── tsconfig.json # TypeScript配置 +``` + +## 配置说明 + +### API配置 + +在 `src/api/request.ts` 中配置基础请求参数： + +```typescript +const instance: AxiosInstance +// 配置请求拦截器和响应拦截器 +``` + +### 路由配置 + +路由文件位于 `src/router/index.ts` 和 `src/router/page.ts` + +### 环境变量 + +通过 `vite.config.ts` 配置环境变量 + +## 浏览器支持 + +- Chrome (推荐) +- Firefox +- Edge +- Safari + +## 许可证 + +本项目遵循 MIT 许可证开源。 + +## 贡献指南 + +欢迎提交 Issue 和 Pull Request。 + +## 联系方式 + +- 项目地址: https://gitee.com/software-minister/jvs-spc-ui +- 问题反馈: https://gitee.com/software-minister/jvs-spc-ui/issues \ No newline at end of file -- Gitee