https://github.com/starknt/starter-electron

An electron template based on Vite and Esbuild.
https://github.com/starknt/starter-electron

boilerplate electron nodejs template typescript vite vitest

Last synced: 3 months ago
JSON representation

An electron template based on Vite and Esbuild.

• Host: GitHub
• URL: https://github.com/starknt/starter-electron
• Owner: starknt
• License: mit
• Created: 2022-07-24T14:16:20.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-14T04:52:20.000Z (over 3 years ago)
• Last Synced: 2025-07-27T23:47:09.973Z (11 months ago)
• Topics: boilerplate, electron, nodejs, template, typescript, vite, vitest
• Language: TypeScript
• Homepage:
• Size: 2.54 MB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Document

[中文](./README_cn.md) | [English](./README.md)

Starter Electron


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




![node-current](https://img.shields.io/node/v/vite)

![npm type definitions](https://img.shields.io/npm/types/typescript)

![GitHub](https://img.shields.io/github/license/starknt/starter-electron)



## HighLights

- 🚀 Fast

- ⚡ Main process reload

- ✈ Multi platform build, based on Github Actions

- 🎉 Minify product size

- 🍛 Two `package.json` structure, [Click here see more](https://www.electron.build/tutorials/two-package-structure)

## Get Started

```bash

  degit starknt/starter-electron projectName

  cd projectName && pnpm install

  pnpm dev

```

or [click here](https://github.com/starknt/starter-electron/generate)

## Project structure

```txt

  .-- 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](./LICENSE)