:electron: Electron + Vite + React + Sass boilerplate.
Go to file
草鞋没号 66e4eee2c0 docs: update 2023-04-17 10:48:37 +08:00
.vscode feat: improvement to template 2022-12-23 23:39:53 +07:00
build fix: icon being too small 2022-12-29 11:59:30 +07:00
e2e Merge branch 'lifeiscontent-feat/playwright' into main 2023-02-14 19:40:13 +08:00
electron fix : tsconfig include electron (#134) (#135) 2023-04-11 11:37:51 +08:00
public feat: better LOGO animate 2023-03-30 20:02:54 +08:00
src feat: better LOGO animate 2023-03-30 20:02:54 +08:00
.gitignore feat: add playwright and example test 2022-12-30 13:52:48 -08:00
.npmrc feat: shamefully hoist 2022-12-27 09:26:46 +07:00
LICENSE feat: update package + pull changes from upstream 2023-01-19 12:54:54 +07:00
README.md docs: update 2023-04-17 10:48:37 +08:00
README.zh-CN.md docs: update 2023-04-17 10:48:37 +08:00
electron-builder.json5 Squashed commit of the following: 2023-03-15 09:20:30 +08:00
index.html feat: update package + pull changes from upstream 2023-01-19 12:54:54 +07:00
package.json chore: bump vite-plugin-electron to 0.11.1, vite-plugin-electron-renderer to 0.13.14 2023-04-17 10:48:26 +08:00
playwright.config.ts feat: add playwright and example test 2022-12-30 13:52:48 -08:00
tsconfig.json fix : tsconfig include electron (#134) (#135) 2023-04-11 11:37:51 +08:00
tsconfig.node.json fix : tsconfig include electron (#134) (#135) 2023-04-11 11:37:51 +08:00
vite.config.ts refactor: `vite-plugin-electron` instead `vite-electron-plugin` 2023-03-30 19:39:42 +08:00

README.md

electron-vite-react

awesome-vite GitHub stars GitHub issues GitHub license Required Node.JS >= 14.18.0 || >=16.0.0

English | 简体中文

👀 Overview

📦 Ready out of the box
🎯 Based on the official template-react-ts, project structure will be familiar to you
🌱 Easily extendable and customizable
💪 Supports Node.js API in the renderer process
🔩 Supports C/C++ native addons
🐞 Debugger configuration included
🖥 Easy to implement multiple windows

🛫 Quick start

npm create electron-vite

electron-vite-react.gif

🐞 Debug

electron-vite-react-debug.gif

📂 Directory structure

Familiar React application structure, just with electron folder on the top 😉
Files in this folder will be separated from your React application and built into dist-electron

├── electron                                 Electron-related code
│   ├── main                                 Main-process source code
│   └── preload                              Preload-scripts source code
│
├── release                                  Generated after production build, contains executables
│   └── {version}
│       ├── {os}-{os_arch}                   Contains unpacked application executable
│       └── {app_name}_{version}.{ext}       Installer for the application
│
├── public                                   Static assets
└── src                                      Renderer source code, your React application

🔧 Additional features

  1. electron-updater 👉 see docs
  2. playwright

FAQ