添加 README.md
This commit is contained in:
117
README.md
Normal file
117
README.md
Normal file
@@ -0,0 +1,117 @@
|
||||
# 🌐 CIM - 运维支撑系统 (完善中。。。)
|
||||
|
||||
本项目基于Pandax标准版开发,仅保留了基础功能。
|
||||
|
||||
---
|
||||
|
||||
## 🗂 项目结构
|
||||
|
||||
```
|
||||
CIM/
|
||||
├── server/ # 后端服务目录
|
||||
| └── main.go # 后端服务入口
|
||||
| └── pandax_iot.sql # 数据库初始化脚本
|
||||
| └── Dockerfile # Docker部署文件
|
||||
├── ui/ # 前端项目目录
|
||||
├── README.md # 项目说明文档
|
||||
```
|
||||
|
||||
- **`server`**:后端服务逻辑、接口、数据库交互等。
|
||||
- **`ui`**:前端界面,基于 Vue 框架开发。
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ 配置说明
|
||||
|
||||
### 🖥 前端配置 (`ui/.env`)
|
||||
|
||||
配置后端 API 地址:
|
||||
|
||||
```env
|
||||
VUE_APP_API_URL=http://172.16.17.32:8000
|
||||
```
|
||||
|
||||
> 示例:若需切换环境,请修改此地址指向目标后端服务。
|
||||
|
||||
---
|
||||
|
||||
### 🔽 后端配置 (`server/.env`)
|
||||
|
||||
配置数据库连接信息:
|
||||
|
||||
```env
|
||||
MYSQL_HOST=172.16.17.32
|
||||
MYSQL_PORT=3306
|
||||
MYSQL_USER=root
|
||||
MYSQL_PASS=your_password_here
|
||||
MYSQL_DB=sucdri
|
||||
```
|
||||
|
||||
✅ 确保数据库服务可访问,并已创建对应数据库。
|
||||
|
||||
---
|
||||
|
||||
## 🚀 指令说明
|
||||
|
||||
### 🎨 前端 (`ui/` 目录下执行)
|
||||
|
||||
| 命令 | 说明 |
|
||||
|--------------------|--------------------|
|
||||
| `npm install` | 安装依赖 |
|
||||
| `npm run dev` | 启动开发服务器(测试) |
|
||||
| `npm run serve` | 启动生产环境服务 |
|
||||
| `npm run build` | 打包编译项目 |
|
||||
|
||||
> 推荐开发时使用 `dev`,部署前使用 `build` 生成静态资源。
|
||||
|
||||
> 服务化部署,请使用server目录下的Dockerfile构建镜像进行部署
|
||||
|
||||
---
|
||||
|
||||
### ⚙️ 后端 (`server/` 目录下执行)
|
||||
|
||||
| 命令 | 说明 |
|
||||
|--------------------|--------------------------|
|
||||
| `go mod tidy` | 安装依赖 |
|
||||
| `go run main.go` | 启动开发模式 |
|
||||
| `go build main.go` | 编译服务器 |
|
||||
|
||||
> 确保数据库配置正确并能正常连接。
|
||||
|
||||
---
|
||||
|
||||
## 🌍 部署访问
|
||||
|
||||
🔗 **当前部署地址**:
|
||||
👉 暂无
|
||||
|
||||
🔐 **默认登录账号**:
|
||||
- **账户**:`panda`
|
||||
- **密码**:`123456`
|
||||
|
||||
---
|
||||
|
||||
## 📝 注意事项
|
||||
|
||||
- 请确保前后端服务在同一网络环境下互通。
|
||||
- 生产部署建议使用 Nginx 反向代理前端,PM2 托管后端服务。
|
||||
- 定期备份数据库,防止数据丢失。
|
||||
|
||||
---
|
||||
|
||||
## 📂 技术栈(建议补充)
|
||||
|
||||
- **前端**:Vue.js, Vue Router, Axios, Element UI
|
||||
- **后端**:Node.js, Express/Koa, MySQL, Sequelize/Knex
|
||||
- **部署**:Nginx, PM2, Docker
|
||||
|
||||
---
|
||||
|
||||
> 💡 如有疑问或问题,请联系项目负责人或查阅内部文档。
|
||||
|
||||
---
|
||||
|
||||
📌 *Version: 1.0.0*
|
||||
📅 *Last Updated: 2025-04-05*
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user