create-electron

An easy way to start an Electron project

Usage

Compatibility Note: Some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.

With npm:

1$ npm create @quick-start/electron

With Yarn:

1$ yarn create @quick-start/electron

With pnpm:

1$ pnpm create @quick-start/electron

Then follow the prompts!

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold an Electron + Vue project, run:

1# npm 6.x
2npm create @quick-start/electron my-app --template vue
3
4# npm 7+, extra double-dash is needed:
5npm create @quick-start/electron my-app -- --template vue
6
7# yarn
8yarn create @quick-start/electron my-app --template vue
9
10# pnpm
11pnpm create @quick-start/electron my-app --template vue

Currently supported template presets include:

JavaScript	TypeScript
vanilla	vanilla-ts
vue	vue-ts
react	react-ts
svelte	svelte-ts
solid	solid-ts

Features

• Use ESLint + Prettier to better lint and style your code, help you to write high-quality code.
• Use electron-vite, a fast build tooling integrated with Vite 3, support for HMR, hot reloading, debugging and source code protection.
• Use electron-toolkit to help you develop. For example: TSconfig extends, easily expose Electron APIs to renderers in preload scripts, etc.
• Use electron-builder and pre-configured to pack your app.
• Use electron-updater for auto-update, based on electron-builder.