330 lines
7.1 KiB
Markdown
330 lines
7.1 KiB
Markdown
|
|
# 知识库管理系统 - 快速启动指南
|
|||
|
|
|
|||
|
|
## 🚀 5分钟快速启动
|
|||
|
|
|
|||
|
|
### 第一步:数据库初始化 (1分钟)
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
# 1. 登录MySQL
|
|||
|
|
mysql -u root -p
|
|||
|
|
|
|||
|
|
# 2. 创建数据库(如果已存在则跳过)
|
|||
|
|
CREATE DATABASE IF NOT EXISTS your_database DEFAULT CHARSET utf8mb4;
|
|||
|
|
|
|||
|
|
# 3. 使用数据库
|
|||
|
|
USE your_database;
|
|||
|
|
|
|||
|
|
# 4. 执行建表脚本
|
|||
|
|
source /Users/mima0000/NL_Pro/flowable_management/base-fast/db/knowledge_module.sql;
|
|||
|
|
|
|||
|
|
# 5. 验证表是否创建成功
|
|||
|
|
SHOW TABLES LIKE '%knowledge%';
|
|||
|
|
SHOW TABLES LIKE '%comment%';
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 第二步:后端启动 (2分钟)
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
# 1. 进入后端目录
|
|||
|
|
cd /Users/mima0000/NL_Pro/flowable_management/base-fast
|
|||
|
|
|
|||
|
|
# 2. 修改数据库配置(如果需要)
|
|||
|
|
# 编辑 src/main/resources/application-dev.yml
|
|||
|
|
# 修改以下配置:
|
|||
|
|
# spring.datasource.url
|
|||
|
|
# spring.datasource.username
|
|||
|
|
# spring.datasource.password
|
|||
|
|
|
|||
|
|
# 3. 启动后端服务
|
|||
|
|
mvn spring-boot:run
|
|||
|
|
|
|||
|
|
# 或者使用IDE启动
|
|||
|
|
# 运行 com.boge.BaseApplication.java
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 第三步:前端启动 (2分钟)
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
# 1. 进入前端目录
|
|||
|
|
cd /Users/mima0000/NL_Pro/flowable_management/base-vue
|
|||
|
|
|
|||
|
|
# 2. 安装依赖(首次运行,约1-2分钟)
|
|||
|
|
npm install
|
|||
|
|
|
|||
|
|
# 3. 启动前端服务
|
|||
|
|
npm run dev
|
|||
|
|
|
|||
|
|
# 4. 浏览器自动打开
|
|||
|
|
# http://localhost:8080
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 第四步:访问系统
|
|||
|
|
|
|||
|
|
1. **登录系统**
|
|||
|
|
- 访问: http://localhost:8080
|
|||
|
|
- 使用系统已有账号登录
|
|||
|
|
|
|||
|
|
2. **配置菜单**(如果菜单不存在)
|
|||
|
|
- 进入系统管理 -> 菜单管理
|
|||
|
|
- 添加新菜单:
|
|||
|
|
- 菜单名称:知识库管理
|
|||
|
|
- 菜单路由:knowledge
|
|||
|
|
- 权限标识:knowledge:knowledge:list
|
|||
|
|
|
|||
|
|
3. **访问知识库**
|
|||
|
|
- 点击左侧菜单"知识库管理"
|
|||
|
|
- 或直接访问: http://localhost:8080/#/knowledge
|
|||
|
|
|
|||
|
|
## ✅ 验证功能
|
|||
|
|
|
|||
|
|
### 1. 测试列表查询
|
|||
|
|
- 打开知识库页面
|
|||
|
|
- 应该看到空列表或已有数据
|
|||
|
|
- 尝试搜索、筛选、排序功能
|
|||
|
|
|
|||
|
|
### 2. 测试新增功能
|
|||
|
|
- 点击"新增"按钮
|
|||
|
|
- 填写表单:
|
|||
|
|
- 标题:测试知识文档
|
|||
|
|
- 分类ID:1
|
|||
|
|
- 内容:这是测试内容
|
|||
|
|
- 点击"确定"保存
|
|||
|
|
|
|||
|
|
### 3. 测试详情功能
|
|||
|
|
- 点击列表中的"查看"按钮
|
|||
|
|
- 查看文档详情
|
|||
|
|
- 测试点赞功能
|
|||
|
|
- 测试评论功能
|
|||
|
|
|
|||
|
|
### 4. 测试编辑功能
|
|||
|
|
- 点击"编辑"按钮
|
|||
|
|
- 修改内容
|
|||
|
|
- 保存更新
|
|||
|
|
|
|||
|
|
### 5. 测试删除功能
|
|||
|
|
- 选择一条记录
|
|||
|
|
- 点击"删除"按钮
|
|||
|
|
- 确认删除
|
|||
|
|
|
|||
|
|
## 📝 API测试(可选)
|
|||
|
|
|
|||
|
|
### 使用Swagger测试
|
|||
|
|
|
|||
|
|
1. 访问Swagger文档
|
|||
|
|
```
|
|||
|
|
http://localhost:8070/base-fast/swagger-ui.html
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
2. 找到"知识库-文档管理"分组
|
|||
|
|
|
|||
|
|
3. 测试接口:
|
|||
|
|
- POST /knowledge/list - 查询列表
|
|||
|
|
- GET /knowledge/info/{id} - 查询详情
|
|||
|
|
- POST /knowledge/save - 新增文档
|
|||
|
|
|
|||
|
|
### 使用Postman测试
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
# 1. 查询列表
|
|||
|
|
POST http://localhost:8070/base-fast/knowledge/list
|
|||
|
|
Content-Type: application/json
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
"page": 1,
|
|||
|
|
"limit": 10,
|
|||
|
|
"status": "PUBLISHED"
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
# 2. 新增文档
|
|||
|
|
POST http://localhost:8070/base-fast/knowledge/save
|
|||
|
|
Content-Type: application/json
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
"title": "测试文档",
|
|||
|
|
"content": "<p>这是测试内容</p>",
|
|||
|
|
"categoryId": 1,
|
|||
|
|
"status": "DRAFT"
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
# 3. 点赞文档
|
|||
|
|
POST http://localhost:8070/base-fast/knowledge/like/1
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 🔧 常见问题解决
|
|||
|
|
|
|||
|
|
### 问题1:后端启动失败
|
|||
|
|
|
|||
|
|
**症状**: 控制台报错,服务无法启动
|
|||
|
|
|
|||
|
|
**解决方案**:
|
|||
|
|
```bash
|
|||
|
|
# 1. 检查数据库连接
|
|||
|
|
# 确认MySQL服务已启动
|
|||
|
|
# 确认数据库配置正确
|
|||
|
|
|
|||
|
|
# 2. 检查端口占用
|
|||
|
|
# 确认8070端口未被占用
|
|||
|
|
lsof -i:8070
|
|||
|
|
|
|||
|
|
# 3. 查看详细错误日志
|
|||
|
|
# 根据错误信息修复问题
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 问题2:前端启动失败
|
|||
|
|
|
|||
|
|
**症状**: npm run dev 报错
|
|||
|
|
|
|||
|
|
**解决方案**:
|
|||
|
|
```bash
|
|||
|
|
# 1. 清除缓存
|
|||
|
|
rm -rf node_modules
|
|||
|
|
rm package-lock.json
|
|||
|
|
|
|||
|
|
# 2. 重新安装依赖
|
|||
|
|
npm install
|
|||
|
|
|
|||
|
|
# 3. 如果还是失败,尝试使用yarn
|
|||
|
|
npm install -g yarn
|
|||
|
|
yarn install
|
|||
|
|
yarn dev
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 问题3:接口404错误
|
|||
|
|
|
|||
|
|
**症状**: 前端调用接口返回404
|
|||
|
|
|
|||
|
|
**解决方案**:
|
|||
|
|
```bash
|
|||
|
|
# 1. 确认后端已启动
|
|||
|
|
# 访问: http://localhost:8070/base-fast
|
|||
|
|
|
|||
|
|
# 2. 检查接口路径
|
|||
|
|
# 确认路径是否正确: /knowledge/list
|
|||
|
|
|
|||
|
|
# 3. 检查代理配置
|
|||
|
|
# 编辑 base-vue/config/index.js
|
|||
|
|
# 确认proxyTable配置正确
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 问题4:数据库连接失败
|
|||
|
|
|
|||
|
|
**症状**: 后端启动报数据库连接错误
|
|||
|
|
|
|||
|
|
**解决方案**:
|
|||
|
|
```bash
|
|||
|
|
# 1. 确认MySQL服务已启动
|
|||
|
|
mysql -u root -p
|
|||
|
|
|
|||
|
|
# 2. 检查数据库配置
|
|||
|
|
# 编辑 application-dev.yml
|
|||
|
|
# 确认url、username、password正确
|
|||
|
|
|
|||
|
|
# 3. 测试数据库连接
|
|||
|
|
# 使用MySQL客户端工具测试连接
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 问题5:菜单不显示
|
|||
|
|
|
|||
|
|
**症状**: 登录后看不到知识库菜单
|
|||
|
|
|
|||
|
|
**解决方案**:
|
|||
|
|
```bash
|
|||
|
|
# 1. 添加菜单
|
|||
|
|
# 进入系统管理 -> 菜单管理
|
|||
|
|
# 添加知识库菜单
|
|||
|
|
|
|||
|
|
# 2. 分配权限
|
|||
|
|
# 进入系统管理 -> 角色管理
|
|||
|
|
# 给当前角色分配知识库权限
|
|||
|
|
|
|||
|
|
# 3. 重新登录
|
|||
|
|
# 退出系统重新登录
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 📂 项目文件位置
|
|||
|
|
|
|||
|
|
### 后端文件
|
|||
|
|
```
|
|||
|
|
/Users/mima0000/NL_Pro/flowable_management/base-fast/
|
|||
|
|
├── src/main/java/com/boge/modules/knowledge/ # Java代码
|
|||
|
|
├── src/main/resources/mapper/knowledge/ # Mapper XML
|
|||
|
|
└── db/knowledge_module.sql # 数据库脚本
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 前端文件
|
|||
|
|
```
|
|||
|
|
/Users/mima0000/NL_Pro/flowable_management/base-vue/
|
|||
|
|
└── src/views/modules/knowledge/ # Vue组件
|
|||
|
|
├── knowledge.vue # 列表页
|
|||
|
|
├── knowledge-detail.vue # 详情页
|
|||
|
|
└── knowledge-add-or-update.vue # 编辑页
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 文档文件
|
|||
|
|
```
|
|||
|
|
/Users/mima0000/NL_Pro/flowable_management/
|
|||
|
|
├── 知识库管理系统-完整开发文档.md # 完整文档
|
|||
|
|
├── 知识库模块开发总结.md # 开发总结
|
|||
|
|
└── 快速启动指南.md # 本文档
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 🎯 下一步建议
|
|||
|
|
|
|||
|
|
### 1. 功能完善
|
|||
|
|
- [ ] 集成富文本编辑器(推荐TinyMCE)
|
|||
|
|
- [ ] 添加图片上传功能
|
|||
|
|
- [ ] 实现文档分类管理
|
|||
|
|
- [ ] 添加标签管理功能
|
|||
|
|
|
|||
|
|
### 2. 性能优化
|
|||
|
|
- [ ] 添加Redis缓存
|
|||
|
|
- [ ] 实现图片懒加载
|
|||
|
|
- [ ] 优化数据库查询
|
|||
|
|
- [ ] 添加CDN加速
|
|||
|
|
|
|||
|
|
### 3. 安全加固
|
|||
|
|
- [ ] 添加XSS过滤
|
|||
|
|
- [ ] 实现CSRF防护
|
|||
|
|
- [ ] 添加访问频率限制
|
|||
|
|
- [ ] 敏感词过滤
|
|||
|
|
|
|||
|
|
### 4. 用户体验
|
|||
|
|
- [ ] 添加Markdown支持
|
|||
|
|
- [ ] 实现代码高亮
|
|||
|
|
- [ ] 添加目录导航
|
|||
|
|
- [ ] 优化移动端显示
|
|||
|
|
|
|||
|
|
## 📞 获取帮助
|
|||
|
|
|
|||
|
|
### 查看文档
|
|||
|
|
1. **完整开发文档**: `知识库管理系统-完整开发文档.md`
|
|||
|
|
2. **后端API文档**: `base-fast/src/main/java/com/boge/modules/knowledge/README.md`
|
|||
|
|
3. **前端使用说明**: `base-vue/src/views/modules/knowledge/README.md`
|
|||
|
|
|
|||
|
|
### 在线资源
|
|||
|
|
- Spring Boot官方文档: https://spring.io/projects/spring-boot
|
|||
|
|
- MyBatis Plus官方文档: https://baomidou.com/
|
|||
|
|
- Vue.js官方文档: https://cn.vuejs.org/
|
|||
|
|
- Element UI官方文档: https://element.eleme.cn/
|
|||
|
|
|
|||
|
|
### 问题反馈
|
|||
|
|
如遇到问题,请检查:
|
|||
|
|
1. 控制台错误日志
|
|||
|
|
2. 浏览器Network请求
|
|||
|
|
3. 数据库表结构
|
|||
|
|
4. 配置文件设置
|
|||
|
|
|
|||
|
|
## 🎉 恭喜
|
|||
|
|
|
|||
|
|
如果您已经成功启动系统并看到知识库页面,那么恭喜您!
|
|||
|
|
|
|||
|
|
知识库管理系统已经成功部署,您可以开始使用了!
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
**快速启动指南**
|
|||
|
|
**版本**: v1.0.0
|
|||
|
|
**更新时间**: 2026-01-28
|
|||
|
|
**预计启动时间**: 5分钟
|
|||
|
|
**难度等级**: ⭐⭐ (简单)
|