Files
website/pages/projects/xiu-admin/guide/tutorial.md
T
2026-11-05 11:54:21 +08:00

56 lines
3.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: 教程视频
description: XiuAdmin 中后台框架的一键部署与二开实操录屏教程
outline: deep
---
# 教程视频
XiuAdmin 是开发底座而不是业务系统,两支视频分别回答「怎么跑起来」和「怎么用它写自己的业务」。
## V6 一键部署:三个容器跑起中后台
| 项 | 内容 |
| --- | --- |
| 标题 | XiuAdmin 一键部署:三个容器跑起中后台 |
| 目标观众 | 要用这个框架搭中后台的开发者 |
| 时长 | 8 ~ 10 分钟 |
| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
| 关联文档 | 代码仓 `deploy/README.md` |
| 关联仓库路径 | `deploy/`、`build/` |
分镜:
1. **三个容器是什么**(1.5 分钟):MySQL 8.0、Redis 7.2、前后端一体应用,MySQL 与 Redis 只在内部网络可达、不映射宿主端口
2. **一条命令启动**(3 分钟):`cd deploy && ./run.sh`,看它自动生成 `.env`(随机数据库口令、Redis 口令、JWT 密钥,权限 600)、拉镜像、起容器、等健康检查通过
3. **访问与改密**(1.5 分钟):打开 `http://<服务器IP>:8199/`,初始账号 admin / 123456 登录后立即改密
4. **常用命令**(1.5 分钟):`status` 看状态与健康检查、`logs` 跟日志、`restart` 改 `.env` 后重建应用容器、`down` 保留数据卷、`destroy` 清数据需二次确认
5. **手工部署路线**(1 分钟):`cp .env.example .env` 后用 `docker compose up -d`,说明 `.env` 里各变量含义(镜像前缀、APP_TAG、APP_PORT、四个口令、JWT_SIGNING_KEY 必须够长且随机)
## V7 框架上手:代码生成到业务模块落地
| 项 | 内容 |
| --- | --- |
| 标题 | XiuAdmin 框架上手:代码生成到业务模块落地 |
| 目标观众 | 要基于框架二次开发的工程师 |
| 时长 | 15 分钟 |
| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
| 关联文档 | 代码仓 `README.md` 的内置功能清单与目录说明 |
| 关联仓库路径 | `server/`、`vue/` |
分镜:
1. **框架全貌**(2 分钟):GoFrame2 后端 + Vue3 前端(Vben Admin)+ Ant Design Vue,单仓结构(`server/`、`vue/`、`docs/`、`build/`、`deploy/`)与「前后端一体镜像」的思路
2. **代码生成**(4 分钟):建表 → 简单配置 → 生成 CURD / 树表 / 消息队列 / 定时任务代码,表单控件勾选即生成
3. **生成代码怎么接进系统**(3 分钟):生成的 API、控制器、菜单权限如何挂进路由,前端页面如何挂进菜单
4. **多租户与数据权限**(2.5 分钟):租户与租户套餐、角色按机构或上下级关系划数据范围
5. **异步与通知**(2 分钟):Asynq 消息队列怎么用、WebSocket 实时推送通知公告与私信
6. **运维视图**(1.5 分钟):在线用户、定时任务、服务监控、缓存监控、附件大文件分片上传
## 录制备忘
- 录屏环境用干净 Ubuntu + Docker,不要连生产或预演环境
- 口令一律打码,`run.sh` 生成随机口令这一步可展示但值要遮住
- 代码生成那段用一个明显的示例表(如 demo_order),避免观众误以为是框架内置表
- 步骤与代码仓 `deploy/README.md` 严格一致,视频里的每条命令都要能原样复制执行