# electron-react-mui-template

**Repository Path**: sliver-ring_admin/electron-react-mui-template

## Basic Information

- **Project Name**: electron-react-mui-template
- **Description**: electron为壳的桌面端快速启动架构，直接把链接发给AI即可
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-25
- **Last Updated**: 2026-08-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Electron + React + MUI 桌面应用启动架构

这套启动架构给完全不懂技术、只会向 AI 描述需求的人使用。使用者不需要会终端、安装依赖、选择状态库或设计代码目录；这些工作由 AI 读取仓库规则后完成。使用者只需要说明要做什么、给谁用，以及对 AI 的产品判断进行确认。遇到暂时不知道的问题，可以直接回答“不知道”，AI 必须解释影响、给出建议并把未确认边界如实记录，不能替使用者编造答案。

它是一套可复用的前端工程架构，不是产品 UI。仓库只保留一个证明窗口、React 与 Electron 窄桥能打开的临时示例；真实项目初始化时，AI 必须完整删除示例页面、路由、文案和测试，不能模仿它的样式或结构。

## 使用者怎么开始

把整个项目文件夹交给能够读写代码的 AI，然后直接复制下面这段话：

> 请接管这个项目。先完整读取 AGENTS.md、AI_TEMPLATE_INIT.md 和 dev-docs/，检查 Git 与本机环境，不要先写业务页面，也不要让我选择技术栈。请一次只向我确认一个产品主题；我说“不知道”时，请解释影响并给出推荐。由你完成环境准备、项目初始化、验证和失败恢复。初始化就绪检查通过后，由你删除临时示例与 AI_TEMPLATE_INIT.md，再做最终检查。任何提交、推送、建远程仓库、签名、公证或公开发布，都必须先单独征得我的同意。

之后使用者只负责两件事：回答产品问题；检查 AI 展示的真实应用结果是否符合需求。命令、依赖、代码、测试和修复都由 AI 负责执行。

## AI 必须先做什么

1. 确认真正的 Git 根、现有改动、分支与远程仓库，保护使用者已有内容。
2. 检查 Node/npm 与 Electron 所需系统环境；缺失时说明用途和影响，再由 AI 安装或给出可执行处理方案。
3. 按 `AI_TEMPLATE_INIT.md` 访谈并写回 `dev-docs/`，不把技术选型问题甩给使用者。
4. 先运行 `npm run check:initialization-ready`。只有它通过，AI 才删除初始化向导和全部启动示例，然后运行 `npm run validate:initialized`。
5. 从真实用户任务和设计证据开始实现第一项功能；不预制 AppShell、导航、表单、状态组件、Snackbar、Dialog 或任何产品 UI。

初始化过程如果失败，AI 必须保留当前文件、读取错误、修正后重试；不能要求使用者手工恢复已删除文件或自己运行命令。

## 已固定的前端架构

- React + TypeScript；所有实际界面组件统一使用 MUI，禁止并行引入第二套组件库或用原生标签重做 MUI 已有能力。
- MUI Theme 是运行时视觉唯一入口；模板不提供品牌色、字体、圆角、阴影、密度或产品组件变体。
- React Router、i18next、Zod、统一 `AppError`、统一 `httpClient` 与可注入 `DesktopBridge`。
- 客户端状态固定使用 Zustand，并且只能从 `src/app/store` 导入；不让使用者选择状态库，也不预制业务 Store。
- 组件选择、封装和复用规则在 `dev-docs/frontend-architecture.md`；设计规则在 `dev-docs/design-system.md`；目录、渲染层隔离与 IPC 边界由机器门禁保护。
- `dev-docs/` 是 AI 持续开发所需的架构真相，必须跟随源码保留。由这套架构创建的真实产品仓库默认应设为私有；公开前由 AI 另做隐私、密钥、许可证和内容审计，不能直接删掉规则文档。

## 给 AI 的验证命令

- `npm run validate`：源码、类型、Lint、测试、架构门禁和 renderer 构建。
- `npm start`：真实 Electron 开发窗口；网页预览不能替代它。
- `npm run candidate:local`：生成当前系统的本地 `.app`/可执行候选，只证明本机打包成功。
- `npm run audit:dependencies`：使用 npm 官方安全审计源检查完整依赖链。

启动架构不预装 maker，也不提供 `make` 或 `publish` 命令。初始化时，AI 必须根据已确认的首发系统、安装格式、签名、公证与发布目标添加最小 maker 和发布配置。源码检查、真实窗口、本地候选包、安装器、签名、公证、更新和远程发布是不同证据，任何一步通过都不能冒充下一步完成。仓库使用 MIT License。