Skip to content

快速开始 ​

欢迎使用 MengStack 文档中心!

什么是 MengStack? ​

MengStack(软盟大基座)是一个面向多租户 SaaS 应用的 Go 通用底座。它把账号、权限、租户、组织、审计、配置、消息、插件等所有 Web 应用共享的能力一次性做好,让你只专注于业务逻辑。

产品矩阵 ​

MengStack 软盟大基座 ​

  • 定位:Go 全栈开发框架
  • 版本:v2.0(当前最新)
  • 文档:查看文档

MengHub APP ​

  • 定位:IM + CRM + 社交 + H5 应用基座
  • 版本:v1.0
  • 文档:查看文档

快速上手 ​

1. 环境准备 ​

确保已安装:

  • Go 1.26+
  • PostgreSQL 16+
  • Redis 7+

2. 获取发行版 ​

bash
# 克隆纯内核基座(9 大核心模块 + 示例插件,不含业务插件,可独立编译启动)
git clone https://mengstackgit.softunis.com/softunis/mengstack-kernel-dist.git
cd mengstack-kernel-dist

发行版说明

  • mengstack-kernel-dist:纯内核基座——认证 / 权限 / 组织 / 审计 / 配置 / 通知 / 仪表盘 / 菜单 / 用户 九大核心模块 + 示例插件,不含业务插件
  • mengstack-plugin-{name}-dist:各业务插件(CMS / 媒体 / 搜索 / 会员等)独立发行,按需引入
  • mengstack-admin-dist:管理后台前端
  • 发行版均为公开仓库,无需认证即可克隆

3. 配置环境 ​

bash
# 复制环境配置
cp .env.example .env

# 编辑 .env,填入数据库密码和 JWT 密钥

4. 启动依赖服务 ​

bash
docker-compose up -d postgres redis

5. 启动服务 ​

bash
# 安装依赖
go mod download

# 运行迁移 + 启动
make run

6. 访问服务 ​

服务启动后:

端点地址
APIhttp://localhost:2222
健康检查http://localhost:2222/health
就绪探针http://localhost:2222/readyz
Swagger 文档http://localhost:2222/swagger/index.html

7. API 文档服务(可选) ​

发行版包含独立的 API 文档服务,提供三种界面:

bash
# 进入 API 文档目录
cd api-docs

# Windows
双击 start.bat

# macOS/Linux
./start.sh

打开配置页面后:

  1. 输入 API 地址:http://localhost:2222
  2. 选择文档类型:
    • Scalar(推荐):现代化界面,支持在线调试
    • Swagger UI:经典界面,功能完整
    • Redoc:只读文档,适合查阅
  3. 点击"打开 API 文档"

API 文档特性

  • ✅ 多环境切换:本地/演示/生产一键切换
  • ✅ 配置持久化:API 地址自动保存
  • ✅ 零依赖:纯静态文件,CDN 加载

下一步 ​

常见问题 ​

Q: MengStack 适合什么场景? ​

A: MengStack 适合构建多租户 SaaS 应用,特别是需要以下能力的场景:

  • 多租户隔离
  • 角色权限管理
  • 插件化扩展
  • 审计日志
  • 国际化支持

Q: 如何贡献文档? ​

A: 文档采用 Monorepo 管理,每个产品/插件有独立目录。提交 PR 到对应目录即可。

Q: 文档支持哪些语言? ​

A: 目前支持中文和英文,通过 VitePress 的多语言功能实现。

Released under the Apache 2.0 License.