Skip to content

Latest commit

 

History

History
74 lines (59 loc) · 2.29 KB

README_cn.md

File metadata and controls

74 lines (59 loc) · 2.29 KB

文档

中文 | English

Starter Electron

基于 Vite 和 ESbuild 用于快速构建 Electron 应用的模板。

node-current npm type definitions GitHub

特性

  • 🚀 极速启动
  • ⚡ 主进程快速重载
  • ✈ 多平台构建
  • 🎉 减少构建产物体积(PS: 自动清理 Native Module 的无效文件)
  • 🍛 双 package.json 结构, 点击这里查看更多

快速开始

  degit starknt/starter-electron projectName
  cd projectName && pnpm install
  pnpm dev

或者 点击此处

项目结构

  .-- 根路径
  |-- .github
  |   |-- workflows # Github Actions 工作流
  |-- .vscode # Vscode 项目配置文件, 用于主进程 Debug
  |-- app
  |   |-- compat # web 和 electron 环境兼容代码 
  |   |-- electron # electron 相关代码
  |   |-- web # web 界面相关代码
  |-- buildResources # 用于构建应用的资源
  |-- assets # 打包到应用内的资源
  |-- release # 应用发布相关
  |   |-- app # 应用的原生模块和应用的 package.json
  |   |   |-- .npmrc
  |   |   |-- package.json
  |   |-- build # 应用打包后, 安装包存放处
  |-- scripts # 存放构建应用的脚本文件
  |-- tests # 存放应用的测试文件
  |-- $electron-builder.json # electron-builder 的配置文件
  |-- alias.ts # 用于生成 vite 和 esbuild 的 Alias 的配置文件
  |-- eevi.config.ts # eevi 插件配置文件
  |-- .eslintignore # eslint ignore files
  |-- .eslintrc # eslintrc 配置文件
  |-- .gitignore # gitignore
  |-- .npmrc # gitignore
  |-- tsconfig.json # tsconfig.json
  |-- tsconfig.node.json # 项目配置文件的tsconfig
  |-- tsconfig.test.json # 项目测试文件的tsconfig
  |-- LICENSE # MIT LICENSE
  |-- README_en.md # 英文文档
  |-- README.md # 中文文档
  |-- vite.config.ts # vitest 的配置文件
  |----------------------------------------------------------------------------------------

开源许可

MIT