From ee137b23a6580e2e80bd56eed9919d9bc10f9fa8 Mon Sep 17 00:00:00 2001 From: MetaZone Date: Sun, 21 Jun 2026 16:43:03 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E9=A1=B9=E7=9B=AE=E6=9B=B4=E5=90=8D?= =?UTF-8?q?=E4=B8=BA=20MetaZone=20Community=20Engine=20(MCE)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 64 +++++++++++++++++++++++++++---------------------------- 1 file changed, 31 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 82173da..99353b2 100644 --- a/README.md +++ b/README.md @@ -3,23 +3,25 @@ Gin 1.12 GORM 1.31 PostgreSQL + Redis AGPL 3.0

-

MetaLab

+

MetaZone Community Engine

-

下一代开源技术社区——为构建者准备的纯粹空间

+

MCE — 下一代开源社区引擎，为 BBS 3.0 而生

--- ## 关于项目 -MetaLab 是一个正在开发中的开源技术社区平台，旨在为开发者提供一个**平等、纯粹、开放**的技术交流空间。 +MCE 是 **MetaZone Community Engine** 的缩写，是 MetaZone 品牌下的社区平台核心引擎。构建于 **MetaGenesis** 体系之上，定位为通用型社区/BBS 平台，面向下一个十年。 **核心理念：** -- 🎯 **专注技术**——代码、架构、逻辑与可验证的事实 -- 🤝 **平等交流**——没有特权，每个成员权利平等 -- 🔓 **开放共享**——鼓励开源、协作与知识共享 +- 🌊 **流式社区**——告别传统板块制，内容以信息流自然流动 +- 🤝 **平等参与**——去中心化讨论，每个成员权利平等 +- 🧩 **模块可组装**——MetaGenesis 框架层提供通用基础能力，引擎层专注社区体验 +- 🔓 **开放共享**——AGPL 开源，鼓励二次开发与生态共建 ## 技术栈 @@ -29,32 +31,33 @@ MetaLab 是一个正在开发中的开源技术社区平台，旨在为开发者 | Web 框架 | **Gin** | 1.12 | | ORM | **GORM** | 1.31 | | 数据库 | **PostgreSQL** | 16+ | -| 认证 | **JWT** (HS256) | v5 | +| 缓存 | **Redis** | 7+ | | 密码加密 | **bcrypt** (cost=12) | — | -| 编辑器 | **Vditor** | 3.11 | +| 编辑器 | **Tiptap** (WYSIWYG) | — | | 前端 | **SSR 模板** (Gin HTML) + 原生 JS/CSS | — | -| 架构 | 分层六边形架构 | — | +| 架构 | 分层架构 (Controller → Service → Repository) | — | ## 当前功能 -- ✅ **用户系统**——注册、登录、登出 -- ✅ **双 Token 认证**——Access Token（15min）+ Refresh Token（7d session / 30d "记住我"），token_version 实时吊销 -- ✅ **CSRF 保护**——全站 CSRF Token，自动注入 state-changing 请求 -- ✅ **速率限制**——API 调用频率控制（账户 + IP 双维度） -- ✅ **安全头**——Content-Security-Policy 等安全响应头 + 登录防时序攻击 -- ✅ **管理后台**——用户管理、角色权限控制 +- ✅ **用户系统**——注册、登录、登出，会话管理 +- ✅ **安全认证**——CSRF 保护、速率限制（账户 + IP）、安全响应头 +- ✅ **管理后台**——用户管理、角色权限控制、审核面板 - ✅ **账号注销**——用户自助注销（7 天冷却期，登录二次确认恢复），站长禁止自删 - ✅ **密码修改**——修改后强制所有设备退登 - ✅ **IP 审计**——记录注册 IP、最后登录 IP 及时间 - ✅ **用户设置页**——个人资料修改（用户名、个性签名、头像上传与裁切） -- ✅ **头像处理**——JPEG/PNG/WebP 上传，方形裁切，512×512 WebP 编码 ≤100KB -- ✅ **消息中心**——审核通知推送，SSR 消息页面，单条/全部标为已读，未读数角标（1/66/99+） -- ✅ **帖子系统**——Markdown 发布/编辑/删除，Vditor 所见即所得编辑器，图片粘贴/拖拽上传 +- ✅ **头像处理**——JPEG/PNG/WebP 上传，方形裁切，512×512 WebP 编码 +- ✅ **消息中心**——通知推送，SSR 消息页面，已读/未读管理，未读数角标 +- ✅ **@提及系统**——@用户搜索、通知推送、通知点击定位高亮 +- ✅ **用户空间**——个人主页 `/space/:uid`，关注/取关，关注列表 +- ✅ **帖子系统**——Markdown 发布/编辑/删除，Tiptap 所见即所得编辑器 - ✅ **代码高亮**——highlight.js 60+ 主题，支持 30+ 编程语言 - ✅ **Shortcode 卡片**——`[zone:event:ID]` 活动/游戏/投票/资源等可扩展卡片 -- ✅ **草稿自动保存**——localStorage 草稿，每 2 秒自动保存 -- ✅ **审核工作流**——帖子 draft → pending → approved/rejected，管理员审核面板 +- ✅ **草稿自动保存**——localStorage 草稿，自动保存 +- ✅ **审核工作流**——帖子 draft → pending → approved/rejected - ✅ **多主题支持**——可切换的前端主题系统 +- ✅ **赋值（赋能）系统**——社区互动激励，赋能溢出截断 + 防自赋能 +- ✅ **收藏功能**——文章收藏，收藏夹管理 ## 计划中 @@ -63,22 +66,18 @@ MetaLab 是一个正在开发中的开源技术社区平台，旨在为开发者 - 🔲 邮箱验证 - 🔲 全文搜索 - 🔲 回收站（用户数据彻底清理） +- 🔲 Redis 会话 & 缓存层深度集成 ## 快速开始 ```bash # 克隆仓库 -git clone git@git.metazone.cc:MetaZone/MetaLab.git -cd MetaLab +git clone git@git.metazone.cc:MetaZone/mce.git +cd mce -# 创建 .env 文件 -cat > .env << EOF -DATABASE_PASSWORD=your_db_password -JWT_SECRET=your_jwt_secret -EOF - -# 确保 PostgreSQL 运行中 -# 默认连接: 127.0.0.1:5432, 数据库: metalab_dev +# 配置数据库和 Redis +cp .env.example .env +# 编辑 .env 填入 PostgreSQL 和 Redis 连接信息 # 运行 go run cmd/server/main.go @@ -89,13 +88,12 @@ go run cmd/server/main.go ## 项目结构 ``` -MetaLab/ +mce/ ├── cmd/server/ # 入口：初始化 → 启动 ├── internal/ │ ├── config/ # 配置加载（YAML + .env） │ ├── router/ # 路由注册 │ ├── controller/ # 控制器（参数绑定 → 调服务 → 返回） -│ │ └── admin/ # 后台控制器 │ ├── service/ # 业务逻辑层 │ ├── repository/ # 数据访问层（DAO） │ ├── model/ # 数据模型 + DTO @@ -119,5 +117,5 @@ MetaLab/ ---

- © 2024-2026 MetaZone | Built with ❤️ by MetaZone + Built on MetaGenesis | © 2024-2026 MetaZone