DoraCMS开发文档

主题

快速开始 ​

本页提供最短路径，细节与参数请跳转对应章节。

环境准备（概览） ​

  • Node.js 18.20+，pnpm 8+
  • 数据库：MongoDB 或 MariaDB（二选一），Redis 可选
  • 详细要求与配置：见 环境准备 与 环境配置

方式零：使用 CLI 工具创建项目（最简单） ​

DoraCMS 提供了官方 CLI 工具，可以快速创建和配置项目，无需手动克隆仓库。

安装 CLI ​

bash
# 使用 pnpm（推荐）
pnpm add -g doracms-cli

# 或使用 npm
npm install -g doracms-cli

创建项目 ​

bash
# 交互式创建（推荐）
doracms create my-project

# 或使用默认配置快速创建
doracms create my-project --yes

CLI 会引导你完成：

  • 选择项目类型（完整全栈/纯后端 API/用户端）
  • 选择数据库（MongoDB/MariaDB）
  • 选择功能模块
  • 自动生成配置文件

启动项目 ​

bash
cd my-project
nano .env              # 配置数据库连接
pnpm run dev:all       # 启动所有服务

详细使用说明请查看 CLI 工具文档

方式一：Docker 一键体验（推荐） ​

最快上手，完整 Profiles/可选组件见 Docker 部署。

bash
git clone https://github.com/doramart/DoraCMS.git
cd DoraCMS
cp docker.env.example .env        # 修改密钥与数据库密码（必改）
docker compose up -d              # 默认 MongoDB 模式
docker compose logs -f eggcms-app # 查看启动日志

访问入口：

常用命令（更多见 运维与排障）：

bash
docker compose ps
docker compose logs -f
docker compose down
docker compose down -v   # ⚠️ 清理数据卷

MariaDB、Redis、Nginx/HTTPS、健康检查等请参阅 Docker 部署 与 部署概览

方式二：本地开发（简版） ​

适合开发调试。完整脚本表与端口见 Monorepo 开发，环境变量与数据库配置见 环境配置。

bash
git clone https://github.com/doramart/DoraCMS.git
cd DoraCMS
pnpm install
pnpm dev        # server + user-center
# 或 pnpm dev:all 启动 server + user-center + admin-center

默认端口：用户前端 3000、管理后台 5173、后端 API 8080。

方式三：生产部署 ​

优先使用 Docker（Docker 部署、部署概览），并遵循 运维与排障 的安全与运维指引（密钥、端口、备份、监控）。如需自管进程，可参考 PM2/Nginx 配置，但推荐统一走容器化方案。