Skip to content

快速开始

本文帮助新同事在本地跑通 MySQL + 后端 + Web 管理后台 最小闭环。

环境要求

工具版本建议
Node.js>= 18
pnpm>= 9(项目使用 corepack)
Docker Desktop用于 MySQL
Java17+(若跑 Java 后端)
Python3.11+(若跑 Python 后端)

启用 pnpm:

bash
corepack enable
corepack prepare pnpm@9.0.0 --activate

1. 克隆与安装

bash
git clone <repo-url> xichen-full-stack
cd xichen-full-stack
pnpm install

不要用 --ignore-scripts

pnpm install --ignore-scripts 会跳过 Electron 的 postinstall,导致 Desktop 无法启动。若只需 Web 开发,仍建议正常安装。

2. 启动 MySQL

bash
docker compose up -d

首次启动会自动执行 contracts/sql/schema.sql 初始化 RBAC 表结构。

3. 启动后端(二选一)

Java 版(默认端口 8080)

bash
pnpm --filter @xichen-full-stack/server-java dev

文档:http://localhost:8080/swagger-ui.html

Python 版(默认端口 8000,可改 8080)

bash
cd packages/server-python
pip install -e .
pnpm dev

文档:http://localhost:8000/docs

4. 构建共享层

Web / Desktop 依赖以下包,首次或变更后需 build:

bash
pnpm --filter @xichen-full-stack/types build
pnpm --filter @xichen-full-stack/auth build
pnpm --filter @xichen-full-stack/api-client build

5. 启动 Web 管理后台

bash
pnpm --filter web dev

浏览器打开 http://localhost:5173

字段
用户名admin
密码admin123

6. 启动 Desktop(可选)

bash
pnpm --filter desktop dev

Electron 窗口开发端口为 5174,路由使用 hash 模式。

验证清单

  • [ ] GET /api/v1/health 返回正常
  • [ ] 登录成功并看到侧边栏菜单
  • [ ] 用户 / 角色 / 菜单管理页可打开
  • [ ] 无权限账号访问接口返回 403

下一步

Xichen Full Stack 内部文档