Files
wiki/qModel/QUICKSTART.md
T
2026-05-14 16:56:48 +08:00

6.9 KiB

🚀 qModel模型管理平台 快速开始指南


一、准备工作 (必备环境)

在运行系统之前,请确保您已安装以下环境:

软件/工具 版本要求 推荐版本
JDK >= 1.8 1.8
MySQL >= 5.7.0 5.7
Neo4j 4.x 4.4.40
Redis >= 5.0 5.0
Maven >= 3.6 3.6
Node.js >= 16 16

提示: 前端安装完 Node.js 后,建议设置淘宝镜像源以提升依赖包下载速度。不推荐使用 cnpm,可能会引入一些不可预知的问题。

npm config set registry https://registry.npmmirror.com

二、获取项目代码 (下载与解压)

前往 【qKnow Gitee 下载页面】 下载项目并解压到您的工作目录。


三、目录结构

2.1 项目结构;

├─qmodel-framework           # 公共配置模块
├─   ├─qmodel-auth           # oauth2模块
├─   ├─qmodel-common         # 共通模块
├─   ├─qmodel-config         # 配置模块
├─   ├─qmodel-es             # es模块
├─   ├─qmodel-file           # 文件管理模块
├─   ├─qmodel-generator      # 代码生成器
├─   ├─qmodel-mybatis        # mybatis配置
├─   ├─qmodel-pay            # 支付模块
├─   ├─qmodel-quartz         # 定时任务模块
├─   ├─qmodel-redis          # redis模块
├─   ├─qmodel-security       # security模块
├─   ├─qmodel-websocket      # websocket模块
├─qmodel-module-model        # 模型管理模块
├─qmodel-module-system       # 系统管理模块
├─qmodel-server              # 启动项目
├─qmodel-ui                  # 前端模块
├─sql                       # sql脚本
├─README.md                 # 相关介绍
├─QUICKSTART.md                 # 快速启动

2.2 前端结构;

├─qmodel-ui                  # 前端模块
├─   ├─public                   # 静态资源目录
├─   ├─src
├─   |  ├─api                   # 接口
├─   |  ├─assets                # 图片、样式等资源
├─   |  ├─components            # 通用组件
├─   |  ├─layout                # 布局
├─   |  ├─plugins               # 插件
├─   |  ├─router                # 路由
├─   |  ├─store                 # 状态管理
├─   |  ├─utils                 # 工具类
├─   |  ├─views                     # 页面视图
├─   |  |   ├─example               # 示例模块(未使用)
├─   |  |   ├─flyflow               # 工作流模块(未使用)
├─   |  |   ├─model                 # 模型管理模块
├─   |  |   ├─system                # 系统管理模块
├─   ├─.env.development         # 开发环境配置
├─   ├─.env.production          # 生产环境配置
├─   ├─vite.config.js           # Vite配置文件

四、必要配置 (数据库与服务配置)

1. 创建达梦数据库并导入数据

  • 创建 达梦 数据库:QMODEL_DEV
  • 导入数据脚本:qModel-2025-12-30.sql

2. 修改达梦数据库连接配置

路径:qModel/qmodel-server/src/main/resources/application-dev.yml

datasource:
  type: dm8

dm8:
  # JDBC驱动类名
  driver-class-name: dm.jdbc.driver.DmDriver
  # 主库JDBC连接URL
  url: 数据库地址
  # 主库用户名
  username: 数据库账号
  # 主库密码
  password: 数据库密码

3. 配置服务端口和访问路径

路径:qModel/qmodel-server/src/main/resources/application.yml

server:
  port: 端口            # 默认为8090
  servlet:
    context-path: /应用路径  # 应用访问路径,默认为空

五、后端运行 (启动服务器)

  1. 使用 IntelliJ IDEA 或 Eclipse 导入项目。
  2. IDE 将自动加载 Maven 依赖,初次加载可能较慢。
  3. 运行 tech.qiantong.qmodel.server.QModelApplication.java。启动成功后,可通过 http://localhost:8090 访问后端服务。
  4. 出现以下提示,表示后端服务启动成功:
(♥◠‿◠)ノ゙  千知平台启动成功   ლ(´ڡ`ლ)゙  
        _  __                    
   __ _| |/ /_ __   _____      __
  / _` | ' /| '_ \ / _ \ \ /\ / /
 | (_| | . \| | | | (_) \ V  V / 
  \__, |_|\_\_| |_|\___/ \_/\_/  
     |_|                         

注意: 仅启动后端服务不会显示静态页面,请继续部署前端服务。


七、前端运行 (启动前端服务)

1. 根据需要修改后台服务端口配置

// vite 相关配置
server: {
  port: 80,
  host: true,
  open: true,
  proxy: {
    "/dev-api": {
      target: "http://localhost:8090",
      changeOrigin: true,
      rewrite: (p) => p.replace(/^\/dev-api/, ""),
    },
  }
}

2. 启动前端服务

步骤 1: 进入项目目录

首先,导航到 qmodel-ui 目录下:

# 进入项目目录
cd qmodel-ui

步骤 2: 安装依赖

接下来,安装项目的依赖包。这里我们使用淘宝镜像源以加速下载速度:

# 安装依赖(推荐使用淘宝镜像)
npm install --registry=https://registry.npmmirror.com

步骤 3: 本地开发并启动项目

最后,运行以下命令来启动前端开发服务器:

# 本地开发 启动项目
npm run dev

3. 测试前端服务

打开浏览器,输入 http://localhost。默认账户/密码为 qModel/qModel123。若能正确展示登录页面,并能成功登录,菜单及页面展示正常,则表明环境搭建成功。

提示: 因为本项目是前后端完全分离的,所以需要前后端都单独启动好,才能进行访问。


希望这个文档能够帮助您更好地理解和操作 qModel模型管理平台 项目!


完成!