onetwo12_cn/OpenSource/smart-ui

Public

Code Issues Pull requests Events Packages Insights

main

smart-ui/README.md

echo

init cnb

2ff83e0b

PreviewCode viewBlame

Raw

Smart 工单系统

Smart-API 工单系统是基于 Go 语言开发的后台管理系统，前后端分离，采用 Gin 框架作为后端，Vue.js 和 Element UI 作为前端。系统旨在实现对工单管理的高效处理，支持任务分配、执行监控、实时更新等功能。

简体中文|English

基于Gin + Vue + Element UI OR Arco Design OR Ant Design的前后端分离权限管理系统,系统初始化极度简单，只需要配置文件中，修改数据库连接，系统支持多指令操作，迁移指令可以让初始化数据库信息变得更简单，服务指令可以很简单的启动api服务

前端项目

后端项目

smart 命名原则

S: 具体，目标明确，不能模糊不清
M: 可度量，量化，评估进展
A: 可实现，切实可行
R: 相关性，与工作相关，确保可以推动
T: 时限性，确保时间内完成

🎬 在线体验

点击访问在线演示

默认登录账户: admin / 123456

✨ 架构特性

遵循 RESTful API 设计规范
基于 GIN WEB API 框架，提供了丰富的中间件支持（用户认证、跨域、访问日志、追踪ID等）
基于Casbin的 RBAC 访问控制模型
JWT 认证
支持 Swagger 文档(基于swaggo)
基于 GORM 的数据库存储，可扩展多种类型数据库
配置文件简单的模型映射，快速能够得到想要的配置
代码生成工具
表单构建工具
多指令模式
多租户的支持
TODO: 单元测试

🤩 功能特色

自定义工单表单：根据实际需求自定义各种类型的工单表单结构
自定义审批流程：可以灵活的设置审批节点的处理人以及多人协助审批
支持LDAP登陆：兼容企业内部LDAP账号认证登陆
支持工单收藏：支持多用户收藏常用的工单
任务工单管理：提供任务的创建、分配、跟踪及执行状态的全面管理。
工单催办：支持发送通知消息和第三方（飞书、钉钉等）消息通知。使用第三方通知时需要联动LDAP账号信息
实时任务监控：通过 WebSocket 实现任务执行状态的实时更新与反馈。
角色权限控制：基于 Casbin 的 RBAC 权限模型，提供细粒度的角色与权限管理。
评分与留言功能：任务完成后可对工单进行评分，并支持多次留言记录。
日志记录：支持详细的操作日志与任务执行日志，便于后续审计与分析。
图表统计：通过图表直观展示工单的统计数据，包括周、月工单统计与个人提交排行。

🎁 内置

多租户：系统默认支持多租户，按库分离，一个库一个租户。
用户管理：用户是系统操作者，该功能主要完成系统用户配置。
部门管理：配置系统组织机构（公司、部门、小组），树结构展现支持数据权限。
岗位管理：配置系统用户所属担任职务。
菜单管理：配置系统菜单，操作权限，按钮权限标识，接口权限等。
角色管理：角色菜单权限分配、设置角色按机构进行数据范围权限划分。
字典管理：对系统中经常使用的一些较为固定的数据进行维护。
参数管理：对系统动态配置常用参数。
操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。
登录日志：系统登录日志记录查询包含登录异常。
接口文档：根据业务代码自动生成相关的api接口文档。
代码生成：根据数据表结构生成对应的增删改查相对应业务，全程可视化操作，让基本业务可以零代码实现。
表单构建：自定义页面样式，拖拉拽实现页面布局。
服务监控：查看一些服务器的基本信息。
内容管理：demo功能，下设分类管理、内容管理。可以参考使用方便快速入门。
定时任务：自动化任务，目前支持接口调用和函数调用。

🛰️ 系统模块

用户管理：支持用户信息的管理及权限分配。
任务中心：提供工单的分配、追踪和状态监控。
工单中心：工单申请和查看工单列表。
流程中心：自定义工单类型、工单表单、审批流程支持多个业务场景。
角色管理：通过角色实现细粒度的权限控制。
日志管理：包括系统操作日志和任务执行日志。
服务监控：实时查看服务器性能与运行状态。
评分与留言：任务结束后支持用户对工单评分并提交评价。

🔧 技术栈

后端: Go, Gin, GORM, JWT, Casbin
前端: Vue.js, Element UI, Axios, WebSocket
数据库: MySQL / PostgreSQL / SQLite
其他工具: Docker, Swagger, GIT

🚀 快速开始

准备工作

你需要在本地安装 go gin node 和 git

📦 环境要求

Go 1.18 及以上版本
Node.js v14.16.0 及以上版本
npm版本: 6.14.11
MySQL 8.0 或其他兼容数据库
Docker 、Kubernetes(可选)

后端安装步骤

克隆项目：


git clone https://github.com/sunwenbo/smart-api.git
cd smart-api

安装依赖：
```
go mod tidy
```
配置数据库连接信息：
```
cp config/settings.full.yml config/settings.yml
```
⚠️：修改 config/settings.yml 中的数据库连接信息确保数据库配置正确，在执行初始化数据库前要先手动创建数据库。
配置文件中修改数据库信息
注意: settings.database 下对应的配置数据
确认log路径
编译
```
go build -o smart-api main.go
```

初始化数据库：


# 首次配置需要初始化数据库资源信息
# macOS or linux 下使用
$ ./smart-api migrate -c config/settings.yml

# ⚠️注意:windows 下使用
$ smart-api.exe migrate -c config/settings.yml

# 启动项目，也可以用IDE进行调试
# macOS or linux 下使用
$ ./smart-api server -c config/settings.yml


# ⚠️注意:windows 下使用
$ smart-api.exe server -c config/settings.yml

sys_api 表的数据如何添加


# 在项目启动时，使用`-a true` 系统会自动添加缺少的接口数据
./smart-api server -c config/settings.yml -a true

更新Swagger文档生成
```
go generate
```

启动服务：


./smart-api server -c config/settings.yml

本地开发数据库迁移


生成迁移文件
go run main.go migrate -g true -c config/settings.yml

生成迁移文件--系统相关
go run main.go migrate -g true -a true  -c config/settings.yml
   
修改完迁移文件后，执行下面命令开始变更
go run main.go migrate -c config/settings.yml

接口管理生成
go run main.go server -c config/settings.yml -a false



常用命令示例

go run main.go migrate -h # 帮助
go run main.go migrate -g true -a true  -c config/settings.yml # 生成smart-api系统预置 迁移文件
go run main.go migrate -g true -c config/settings.yml  # 生成 自定义功能 迁移文件 自己开发新功能用这个功能
go run main.go migrate -c config/settings.yml # 执行迁移命令 迁移 未迁移过的 文件

参数说明：

-h # 帮助
-c # 指定配置文件 默认使用 -c config/settings.yml 配置文件
-a # 生成 系统预置 迁移文 生成到` cmd/migrate/migration/version ` go-admin系统迁移文件在这目录里操作，最好不要动，方便同步升级
-g # 生成迁移文 生成到` cmd/migrate/migration/version-local `  自己开发新功能的迁移文件在这目录里操作

交叉编译


# windows
env GOOS=windows GOARCH=amd64 go build main.go

# or
# linux
env GOOS=linux GOARCH=amd64 go build main.go

前端安装步骤

克隆前端项目：


git clone https://github.com/sunwenbo/smart-ui.git
cd smart-ui

安装依赖：


npm config set registry https://registry.npmmirror.com/  
npm config get registry
npm install --legacy-peer-deps

启动开发服务器：
```
npm run dev
```
访问地址：

打开浏览器并访问 http://localhost:9527 查看前端界面。

使用docker启动

非本地部署时要先初始化数据库的数据，可以使用本地编译后的二进制文件执行如下命令

后端

⚠️⚠️⚠️要修改settings.yml 文件中的数据库信息，同样需要手动创建smart-api库


./smart-api migrate -c config/settings.yml

本地如果是arm架构，但是想构建为x86架构的镜像，mac为例


# 构建镜像
docker buildx build --platform linux/amd64 -t registry.cn-beijing.aliyuncs.com/sunwenbo/smart-api:latest . --load    
# 推向镜像仓库
docker push registry.cn-beijing.aliyuncs.com/sunwenbo/smart-api:latest
# 启动后端服务，挂载settings.yml文件， 我将配置文件放在了"/data/config/" 目录下
docker run -itd  \
  -p 8000:8000 \
  -v /data/config/:/home/service/config/ \
  --name smart-api \
  registry.cn-beijing.aliyuncs.com/sunwenbo/smart-api:latest

前端


# 构建镜像
docker buildx build --platform linux/amd64 -t registry.cn-beijing.aliyuncs.com/sunwenbo/smart-ui:latest . --load
# 推向镜像仓库
docker push registry.cn-beijing.aliyuncs.com/sunwenbo/smart-ui:latest 
# 启动前端服务，挂载nginx的配置文件
docker run -itd  \
  -p 80:80 \
  -v /data/default.conf:/etc/nginx/conf.d/default.conf \
  --name smart-ui \
  registry.cn-beijing.aliyuncs.com/sunwenbo/smart-ui:latest

查看部署后状态

使用kubernetes部署

初始化数据方法如上☝️

后端


cd smart-api/scripts/
bash install.sh

前端


cd smart-ui/scripts/
执行部署前要修改yaml中的配置，例如ingress
bash install.sh

检查部署情况


kubect get cm -n sre 
kubect get pod -n sre 
kubect get ingress -n sre

使用说明

登录系统：使用默认管理员账户 admin 登录系统。
创建工单：进入任务管理页面，点击“创建工单”，填写相关信息并分配处理人。
任务执行监控：通过系统内的任务执行界面，可实时查看任务的执行状态、执行结果及日志。
工单评分与留言：工单结束后，用户可以对工单进行评分，并通过留言功能记录对工单处理过程的反馈。

系统截图

[数据统计]

[工单申请]

[自定义流程]

[自定义模板]

[工单管理]

[任务类型]

登录界面

工单管理

实时任务监控

贡献指南

欢迎社区开发者贡献代码或提供意见。如果你想参与本项目，请参考以下步骤：

Fork 本仓库：点击右上角的 Fork 按钮将项目复制到你的 GitHub 账户。
克隆你的 Fork：在终端中运行以下命令，将项目克隆到本地：
```
git clone https://github.com/your-username/smart-api-backend.git
```
创建一个分支：在克隆的项目目录下，创建一个新分支用于开发：
```
git checkout -b feature-branch-name
```
提交你的改动：进行开发后，使用 git add 和 git commit 提交你的代码改动。
```
git add .
git commit -m "描述你的改动"
```
发起 Pull Request：在 GitHub 上提交 Pull Request，请确保你的代码通过了所有测试并遵循代码风格。