Document

中文 | English

Starter Electron

A template for quickly building Electron applications based on Vite and ESbuild.

HighLights

• 🚀 Fast
• ⚡ Main process reload
• ✈ Multi platform build, based on Github Actions
• 🎉 Minify product size
• 🍛 Two package.json structure, Click here see more

Get Started

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

or click here

Project structure

  .-- root path
  |-- .github
  |   |-- workflows # Github Actions
  |-- .vscode
  |-- app
  |   |-- compat # web and electron environment compat code
  |   |-- electron # electron code
  |   |-- web # web ui
  |-- buildResources # build resources
  |-- packages # like monore
  |-- release # release application
  |   |-- app # install application native module
  |   |   |-- .npmrc
  |   |   |-- package.json
  |   |-- build # packaged application
  |-- scripts # build application script
  |-- tests # tests files
  |-- $electron-builder.json # electron-builder configuration
  |-- alias.ts # vite and esbuild  alias file
  |-- eevi.config.ts # eevi config file
  |-- .eslintignore # eslint ignore files
  |-- .eslintrc # eslintrc
  |-- .gitignore # gitignore
  |-- .npmrc # 
  |-- tsconfig.json # tsconfig.json
  |-- tsconfig.node.json # tsconfig.node.json
  |-- tsconfig.test.json # tsconfig.test.json
  |-- LICENSE # MIT LICENSE
  |-- README_en.md
  |-- README.md
  |-- vite.config.ts
  |------------------------------------------------------------------------------------------------

License

MIT