README.md

Umi Electron Template

一个基于 umi 和 umi-plugin-electron-builder 的开发模板

特性

架构

• 基于 umi-plugin-electron-builder 构建，享受完整 umi 开发生态；
• 采用 electron-builder 打包构建工具；
• 使用 Main 与 Renderer 双目录架构；
• 基于 inversify 实现 DI/IoC

内置功能

• 样式框架: 集成 antd-style；
• 数据持久化: 集成 sqlite3 作为本地数据库， TypeORM 作为 ORM；
• 签名公证: 集成 macOS App 签名与公证，包含在 CI/CD 流程中；

开发体验

• 集成 react-devtools 与 Redux Dev Tools；
• 基于 Gitmoji Commit Workflow, 实现自动化版本管理与发布；

快速上手

安装

通过 git 下载这个仓库到本地

然后通过 yarn 下载安装依赖

yarn

开发

通过以下命令启动渲染进程(默认端口：7777)

yarn start

构建

yarn build

构建文件会输出到 release 目录下：

release
├── builder-effective-config.yaml
├── bundled
│   ├── home.html
│   ├── index.html
│   ├── main.js
│   ├── main.js.map
│   ├── node_modules
│   ├── package.json
│   ├── static
│   ├── umi.css
│   └── umi.js
├── latest-mac.yml
├── mac
│   └── Umi Electron Template.app
├── umi-electron-template_setup_1.8.1.dmg
└── umi-electron-template_setup_1.8.1.dmg.blockmap

开发指南

详见 开发指南

License

MIT ® Arvin Xu