Skip to content

快速开始

本页用于本地体验和开发启动。生产部署请看 部署指南

环境要求

依赖版本
PHP>= 8.4(PDO、mbstring、fileinfo、curl、openssl、GD、ZipArchive、redis 扩展)
MySQL>= 8.0
Redis>= 7.0
Node.js>= 18,推荐 20+
Composer最新版
pnpm推荐 9+
DockerDocker 24+,Docker Compose v2+

Docker 一键启动

仓库根目录提供 Makefile,会启动容器、安装后端依赖、执行 saas:install,并创建默认平台管理员和演示租户。

bash
git clone https://gitee.com/yuandianxitong/ydadmin-saas.git
cd ydadmin-saas
make setup

启动后访问:

入口地址说明
平台后台http://admin.localhost平台运营者管理租户、套餐、插件、订单
演示租户后台http://demo.localhost租户管理员日常使用后台

TIP

admin.localhostdemo.localhost 通常会自动解析到 127.0.0.1。如果你的环境不支持,手动在 hosts 中添加这两个域名。

常用命令:

bash
make status   # 查看服务状态
make logs     # 查看容器日志
make stop     # 停止服务
make clean    # 删除容器和数据卷,会清空数据

手动开发启动

1. 后端依赖

bash
cd server
composer install
cp .env.example .env
php think saas:install
php think saas:create-platform-admin --default

确保 .env 中至少配置数据库、Redis、JWT_TENANT_SECRETJWT_PLATFORM_SECRETSAAS_ROOT_DOMAINSAAS_PLATFORM_DOMAIN

2. 前端开发服务

分别启动需要开发的前端:

bash
# 平台超管后台
cd platform
pnpm install
pnpm dev

# 租户后台
cd tenant
pnpm install
pnpm dev

# PC 公共前台
cd pc
pnpm install
pnpm dev

# 移动端
cd uniapp
pnpm install
pnpm dev:h5

初始化插件应用

开源仓库内置了 mallcms 两个演示插件。本地体验插件流程时:

  1. 进入平台后台的插件管理。
  2. 登记磁盘插件,例如 mall
  3. 安装插件。
  4. 在套餐中授权插件。
  5. 登录租户后台,在插件应用中启用插件。

开发者可继续阅读 插件开发指南

必跑任务

生产或长期联调环境需要启动队列和定时任务:

bash
cd server
php think queue:work --queue default
php think saas:tenant-lifecycle
php think saas:order-cleanup

完整业务流程见 业务流程,运维命令见 运维命令

基于 Apache-2.0 协议开源