Skip to content

electron-vite/electron-vite-react

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 Setup

# clone the project
git clone https://github.com/electron-vite/electron-vite-react.git

# enter the project directory
cd electron-vite-react

# install dependency
npm install

# develop
npm run dev

๐Ÿž 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