a-fast-electron
v31.0.5
Published
Quickly create a desktop application
Readme
fast-electron
fast-electron 的本地脚手架 MVP。
本项目及生成出来的所有 package.json 都以 Node.js 24+ 为最低运行版本:
"engines": {
"node": ">=24.0.0"
}脚手架可以全局安装,安装后直接在任意目录执行 fast-electron 创建项目。
推荐全局安装:
bun add -g a-fast-electron
npm install -g a-fast-electron
pnpm add -g a-fast-electron
yarn global add a-fast-electron
deno install -g -A -n fast-electron npm:a-fast-electron@latest安装后使用:
fast-electron
fast-electron my-electron-app创建过程中会自动完成:
- 创建 renderer
- 初始化项目
- 集成 renderer
- 安装依赖
- 生成启动和打包命令
注意:发布包名为
a-fast-electron,全局命令仍然是fast-electron。
本地测试
cd d:\项目文件\fast-electron-CLI
bun .\bin\create-fast-electron.mjs my-electron-app或者直接用 Node 启动 CLI:
cd d:\项目文件\fast-electron-CLI
node .\bin\create-fast-electron.mjs my-electron-app发布后使用
发布包 a-fast-electron 后,全局安装:
bun add -g a-fast-electron
npm install -g a-fast-electron
pnpm add -g a-fast-electron
yarn global add a-fast-electron
deno install -g -A -n fast-electron npm:a-fast-electron@latest然后在要创建项目的目录执行:
fast-electron
fast-electron my-electron-app脚手架会检测电脑里已经安装的包管理器/运行时,并在安装依赖前让你选择使用哪一个。
创建流程
- 询问项目名称。
- 复制 Electron 模板。
- 执行对应包管理器的
create vite交互,让你选择前端框架。 - 执行模板的 renderer 集成脚本。
- 检测电脑里已安装的包管理器/运行时。
- 询问是否安装依赖,以及选择使用哪一个包管理器/运行时安装依赖。
生成项目后的常用命令
cd my-electron-app
npm install
npm run start
# 或者
pnpm install
pnpm run start
# 或者
bun install
bun run start打包:
npm run compile:win
npm run compile:mac
npm run compile:linux
# 或者使用 pnpm / bun 对应命令