码桶

发现社区成员的开源项目

twelve / 公开

版本历史

5 次提交

提交详情

52f8297
提交编号52f8297f3ba06676cd05b6a460f79e3a9aa9e6b9
提交作者twelve<codebucket@localhost>
提交时间2026-08-04 00:41:23 +0800
更新说明更新 README.md

文件变更 1 个文件

文件新增删除
README.md+120-120

文件差异 逐行查看本次提交的修改

README.md+120-120
@@ -1,120 +1,120 @@
1-# XIUNOX
2-
3-> **当前版本:v1.1.0**
4-
5-基于 [Xiuno BBS 4.0.4](xiunobbs4.0.4.md) 原版打造的现代化重构版本 XIUNOX。
6-(项目前期曾使用 Xiuno BBS v4.5+、Xiuno Next 作为项目名称,现已更名为 XIUNOX)
7-
8-全面适配 PHP 8 + MySQL 8,采用 Bootstrap 5.3 与 HTMX 4 构建现代无刷新 UI,
9-安全与可扩展性大幅提升,原生支持多语言、RESTful API,让轻量论坛重获新生。
10-
11-## 技术栈
12-
13-- **后端**:PHP 8.0+ / MySQL 8(pdo_mysql)
14-- **前端**:Bootstrap 5.3 / htmx 4.1(含 hx-live、hx-optimistic 扩展)/ Tabler Icons 2.1
15-- **编辑器**:AIEditor(内置 AI 续写/优化能力,对接 AIService)
16-- **动画**:anime.js
17-- **架构**:htmx 纯净架构(服务端渲染 + 乐观更新 + morph DOM 保留)
18-- **安全**:CSRF 防护 / XSS 防护(EscapeService)/ 参数化查询 / 登录限速 / 操作审计
19-- **缓存**:MySQL / Redis / Memcached / Yac
20-- **API**:v1 版本 RESTful API,支持 Token 认证
21-
22-## 核心特性
23-
24-- 响应式布局,自适应手机、平板、PC
25-- htmx 4 驱动交互:局部刷新、乐观更新、morph DOM 保留,无刷新发帖/回复/操作
26-- 插件机制:hook + overwrite,方便二次开发;内置插件扫描器与崩溃自动禁用
27-- 多语言支持:简体中文、繁体中文、英文
28-- 附件管理:图片缩略、视频信息获取(ffprobe 可选)、图片裁剪
29-- 积分系统:多类型积分、每日限额、日志审计
30-- 安全防护:验证码、IP 黑名单、敏感词过滤、登录限速、操作审计
31-- AI 服务:内置 AIService 抽象,支持多 Provider 接入;AIEditor 提供 AI 续写/优化
32-- 代码高亮:highlight.js(仅帖子详情页加载)
33-- 数据可视化:Chart.js
34-- 二维码:qrcode.js
35-- RESTful API:v1 版本 API,支持 Token 认证
36-- 后台管理:用户 / 版块 / 插件 / 主题 / 安全 / AI 等完整管理功能
37-
38-## 目录结构
39-
40-```
41-xiunobbs/
42-├── admin/ # 后台管理(route + view + 菜单配置)
43-├── api/v1/ # RESTful API v1
44-├── conf/ # 配置文件(conf / smtp / attach / email 模板)
45-├── config/ # 安全配置(敏感词、保留词)
46-├── cli/ # 命令行脚本(密码迁移、积分同步)
47-├── cron/ # 定时任务
48-├── docs/ # 文档
49-│ ├── userguide/ # 前后台使用指南
50-│ └── plugindev/ # 插件开发手册(多文件版)
51-├── install/ # 安装程序
52-├── lang/ # 多语言包(zh-cn / zh-tw / en-us)
53-├── lib/ # 核心类库(Service、Security、PHPMailer、HTMLPurifier 等)
54-├── model/ # 数据模型(func.php 函数库)
55-├── plugin/ # 插件目录
56-├── route/ # 前台路由
57-├── service/ # 业务 Service 层
58-├── view/ # 前台资源
59-│ ├── htm/ # HTM 模板文件
60-│ ├── js/ # 自研 JS(xiuno-modern.js、bbs.js、aieditor 等)
61-│ ├── css/ # 样式(bootstrap-bbs.css、theme.css)
62-│ ├── img/ # 静态图片
63-│ └── vendor/ # 前端第三方库(bootstrap / htmx / animejs / chartjs 等)
64-├── xiunophp/ # 核心框架(db / cache / image / 加密 / 邮件等基础函数)
65-├── upload/ # 上传文件
66-└── tmp/ # 编译缓存(_include 编译产物 + cache 数据缓存)
67-```
68-
69-## 快速开始
70-
71-详见 [安装教程](install.md)。
72-
73-## 使用文档
74-
75-- [前台操作指南](docs/userguide/frontend-guide.md)
76-- [后台操作指南](docs/userguide/backend-guide.md)
77-
78-## 插件开发
79-
80-详见 [插件开发手册](docs/plugindev/README.md)(多文件版,推荐);
81-旧版 [plugindev.md](plugindev.md) 保留作为历史参考。
82-
83-## 多语言支持
84-
85-| 语言 | 代码 |
86-|------|------|
87-| 简体中文 | zh-cn |
88-| 繁体中文 | zh-tw |
89-| 英文 | en-us |
90-
91-## 授权协议
92-
93-MIT 协议,附加版权保留要求条款。可自由修改、派生版本、商用,但**必须保留前后台版权标识**:
94-
95-- **前台页脚**的 "Powered by XIUNOX" 标识必须完整保留,不得删除、隐藏或篡改
96-- **后台页脚**的 "Powered by XIUNOX Based on Xiuno BBS" 标识必须完整保留
97-- 不得通过 CSS 隐藏、配置关闭或任何技术手段移除上述版权标识
98-
99-详见 [LICENSE](LICENSE)。安装时将在协议页显示完整许可文本。
100-
101-## 使用的库
102-
103-| 库 | 版本 | 说明 |
104-|----|------|------|
105-| Bootstrap | 5.2.3 | UI 框架 |
106-| htmx |4.0.0| 无刷新交互(含 hx-live / hx-optimistic 扩展) |
107-| Tabler Icons | v3.45.0 | 图标库 |
108-| AIEditor | - | 富文本编辑器,内置 AI 能力 |
109-| anime.js | - | 轻量动画库 |
110-| Chart.js | - | 数据可视化图表 |
111-| Cropper.js | - | 图片裁剪 |
112-| highlight.js | - | 代码高亮(仅帖子页加载) |
113-| qrcode.js | - | 二维码生成 |
114-| jQuery | 3.7.1 | 兼容遗留(1.1.4 版本开始弃用) |
115-| PHPMailer | - | 邮件发送(内置 `lib/`) |
116-| HTMLPurifier | - | HTML 净化(内置 `lib/`) |
117-
118-## Based on
119-
120-Xiuno BBS 4.0.4 — https://github.com/xiuno/xiunobbs
1+# XIUNOX
2+
3+> **当前版本:v1.1
4+
5+基于 [Xiuno BBS 4.0.4](xiunobbs4.0.4.md) 原版打造的现代化重构版本 XIUNOX。
6+(项目前期曾使用 Xiuno BBS v4.5+、Xiuno Next 作为项目名称,现已更名为 XIUNOX)
7+
8+全面适配 PHP 8 + MySQL 8,采用 Bootstrap 5.3 与 HTMX 4 构建现代无刷新 UI,
9+安全与可扩展性大幅提升,原生支持多语言、RESTful API,让轻量论坛重获新生。
10+
11+## 技术栈
12+
13+- **后端**:PHP 8.0+ / MySQL 8(pdo_mysql)
14+- **前端**:Bootstrap 5.3 / htmx 4.1(含 hx-live、hx-optimistic 扩展)/ Tabler Icons 2.1
15+- **编辑器**:AIEditor(内置 AI 续写/优化能力,对接 AIService)
16+- **动画**:anime.js
17+- **架构**:htmx 纯净架构(服务端渲染 + 乐观更新 + morph DOM 保留)
18+- **安全**:CSRF 防护 / XSS 防护(EscapeService)/ 参数化查询 / 登录限速 / 操作审计
19+- **缓存**:MySQL / Redis / Memcached / Yac
20+- **API**:v1 版本 RESTful API,支持 Token 认证
21+
22+## 核心特性
23+
24+- 响应式布局,自适应手机、平板、PC
25+- htmx 4 驱动交互:局部刷新、乐观更新、morph DOM 保留,无刷新发帖/回复/操作
26+- 插件机制:hook + overwrite,方便二次开发;内置插件扫描器与崩溃自动禁用
27+- 多语言支持:简体中文、繁体中文、英文
28+- 附件管理:图片缩略、视频信息获取(ffprobe 可选)、图片裁剪
29+- 积分系统:多类型积分、每日限额、日志审计
30+- 安全防护:验证码、IP 黑名单、敏感词过滤、登录限速、操作审计
31+- AI 服务:内置 AIService 抽象,支持多 Provider 接入;AIEditor 提供 AI 续写/优化
32+- 代码高亮:highlight.js(仅帖子详情页加载)
33+- 数据可视化:Chart.js
34+- 二维码:qrcode.js
35+- RESTful API:v1 版本 API,支持 Token 认证
36+- 后台管理:用户 / 版块 / 插件 / 主题 / 安全 / AI 等完整管理功能
37+
38+## 目录结构
39+
40+```
41+xiunobbs/
42+├── admin/ # 后台管理(route + view + 菜单配置)
43+├── api/v1/ # RESTful API v1
44+├── conf/ # 配置文件(conf / smtp / attach / email 模板)
45+├── config/ # 安全配置(敏感词、保留词)
46+├── cli/ # 命令行脚本(密码迁移、积分同步)
47+├── cron/ # 定时任务
48+├── docs/ # 文档
49+│ ├── userguide/ # 前后台使用指南
50+│ └── plugindev/ # 插件开发手册(多文件版)
51+├── install/ # 安装程序
52+├── lang/ # 多语言包(zh-cn / zh-tw / en-us)
53+├── lib/ # 核心类库(Service、Security、PHPMailer、HTMLPurifier 等)
54+├── model/ # 数据模型(func.php 函数库)
55+├── plugin/ # 插件目录
56+├── route/ # 前台路由
57+├── service/ # 业务 Service 层
58+├── view/ # 前台资源
59+│ ├── htm/ # HTM 模板文件
60+│ ├── js/ # 自研 JS(xiuno-modern.js、bbs.js、aieditor 等)
61+│ ├── css/ # 样式(bootstrap-bbs.css、theme.css)
62+│ ├── img/ # 静态图片
63+│ └── vendor/ # 前端第三方库(bootstrap / htmx / animejs / chartjs 等)
64+├── xiunophp/ # 核心框架(db / cache / image / 加密 / 邮件等基础函数)
65+├── upload/ # 上传文件
66+└── tmp/ # 编译缓存(_include 编译产物 + cache 数据缓存)
67+```
68+
69+## 快速开始
70+
71+详见 [安装教程](install.md)。
72+
73+## 使用文档
74+
75+- [前台操作指南](docs/userguide/frontend-guide.md)
76+- [后台操作指南](docs/userguide/backend-guide.md)
77+
78+## 插件开发
79+
80+详见 [插件开发手册](docs/plugindev/README.md)(多文件版,推荐);
81+旧版 [plugindev.md](plugindev.md) 保留作为历史参考。
82+
83+## 多语言支持
84+
85+| 语言 | 代码 |
86+|------|------|
87+| 简体中文 | zh-cn |
88+| 繁体中文 | zh-tw |
89+| 英文 | en-us |
90+
91+## 授权协议
92+
93+MIT 协议,附加版权保留要求条款。可自由修改、派生版本、商用,但**必须保留前后台版权标识**:
94+
95+- **前台页脚**的 "Powered by XIUNOX" 标识必须完整保留,不得删除、隐藏或篡改
96+- **后台页脚**的 "Powered by XIUNOX Based on Xiuno BBS" 标识必须完整保留
97+- 不得通过 CSS 隐藏、配置关闭或任何技术手段移除上述版权标识
98+
99+详见 [LICENSE](LICENSE)。安装时将在协议页显示完整许可文本。
100+
101+## 使用的库
102+
103+| 库 | 版本 | 说明 |
104+|----|------|------|
105+| Bootstrap | 5.2.3 | UI 框架 |
106+| htmx |4.0.0| 无刷新交互(含 hx-live / hx-optimistic 扩展) |
107+| Tabler Icons | v3.45.0 | 图标库 |
108+| AIEditor | - | 富文本编辑器,内置 AI 能力 |
109+| anime.js | - | 轻量动画库 |
110+| Chart.js | - | 数据可视化图表 |
111+| Cropper.js | - | 图片裁剪 |
112+| highlight.js | - | 代码高亮(仅帖子页加载) |
113+| qrcode.js | - | 二维码生成 |
114+| jQuery | 3.7.1 | 兼容遗留(1.1.4 版本开始弃用) |
115+| PHPMailer | - | 邮件发送(内置 `lib/`) |
116+| HTMLPurifier | - | HTML 净化(内置 `lib/`) |
117+
118+## Based on
119+
120+Xiuno BBS 4.0.4 — https://github.com/xiuno/xiunobbs