:electron: Electron + Vite + React + Sass boilerplate.
Go to file
草鞋没号 458694315d docs: v2.0.0 2022-06-10 09:16:43 +08:00
.vscode fix: debug bootstrap logic 2022-06-07 09:49:42 +08:00
electron refactor: minor changes 2022-06-06 21:23:25 +03:00
public 📦 refactor: package, static, editorconfig 2022-06-06 12:42:38 +03:00
src refactor: minor changes 2022-06-06 21:23:25 +03:00
.editorconfig 📦 refactor: package, static, editorconfig 2022-06-06 12:42:38 +03:00
.gitignore update 2022-06-05 08:02:20 +08:00
LICENSE Initial commit 2021-11-01 01:54:59 +00:00
README.md docs: v2.0.0 2022-06-10 09:16:43 +08:00
README.zh-CN.md docs: v2.0.0 2022-06-10 09:16:43 +08:00
electron-builder.json5 Improve artifact names in electron-builder.json5 2022-06-08 13:26:25 +01:00
index.html template-react-ts/index.html 2022-06-05 08:30:46 +08:00
package.json chore: bump vite to 2.9.10 2022-06-07 12:46:08 +03:00
tsconfig.json feat: use path aliases, improve TS 2022-06-06 21:23:07 +03:00
tsconfig.node.json template-react-ts/tsconfig.json 2022-06-05 08:08:12 +08:00
types.d.ts refactor: minor changes 2022-06-06 21:23:25 +03:00
vite.config.ts fix(🐞): set `build.outDir` explicitly 2022-06-07 11:01:32 +08:00

README.md

electron-vite-react

awesome-vite GitHub stars GitHub issues GitHub license Required Node.JS >= v14.17.0

English | 简体中文

Overview

📦 Out of the box
💪 Support C/C++ addons
🔩 Support Use Electron、Node.js API in Renderer-process
🌱 Simple directory structurereal flexible
🖥 It's easy to implement multiple windows

Quick start

npm create electron-vite

electron-vite-react.gif

Debug

electron-vite-react-debug.gif

Directory structure

🚨 By default, the files in electron folder will be built into the dist/electron

├── electron                  Electron-related code
|   ├── main                  Main-process source code
|   ├── preload               Preload-script source code
|   └── resources             Resources for the production build
|       ├── icon.icns             Icon for the application on macOS
|       ├── icon.ico              Icon for the application
|       ├── installerIcon.ico     Icon for the application installer
|       └── uninstallerIcon.ico   Icon for the application uninstaller
|
├── release                   Generated after production build, contains executables
|   └──{version}
|       ├── {os}-unpacked     Contains unpacked application executable
|       └── Setup.{ext}       Installer for the application
|
├── public                    Static assets
└── src                       Renderer source code, your React application

dependencies vs devDependencies

  • First, you need to know if your dependencies are needed after the application is packaged.

  • Like serialport, sqlite3 they are node-native modules and should be placed in dependencies. In addition, Vite will not build them, but treat them as external modules.

  • Dependencies like Vue and React, which are pure javascript modules that can be built with Vite, can be placed in devDependencies. This reduces the size of the application.