76 lines
3.6 KiB
Markdown
76 lines
3.6 KiB
Markdown
# electron-vite-react
|
|
|
|
[](https://github.com/vitejs/awesome-vite)
|
|
|
|
|
|
|
|
[](https://nodejs.org/about/releases)
|
|
|
|
English | [简体中文](README.zh-CN.md)
|
|
|
|
## 👀 Overview
|
|
|
|
📦 Ready out of the box
|
|
🎯 Based on the official [react-ts](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) template, 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
|
|
|
|
```sh
|
|
npm create electron-vite
|
|
```
|
|
|
|
|
|
|
|
## 🪲 Debug
|
|
|
|
|
|
|
|
## 📂 Directory structure
|
|
|
|
Familiar React application structure, just with `electron` folder on the top :wink:
|
|
*Files in this folder will be separated from your React application and built into `dist/electron`*
|
|
|
|
```tree
|
|
├── electron Electron-related code
|
|
│ ├── main Main-process source code
|
|
│ ├── preload Preload-scripts 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
|
|
```
|
|
|
|
## 🚨 Be aware
|
|
|
|
This template integrates Node.js API to the renderer process by default. If you want to follow **Electron Security Concerns** you might want to disable this feauture. You will need to expose needed API by yourself.
|
|
|
|
To get started, remove the option as shown below. This will [modify the Vite configuration and disable this feature](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#config-presets-opinionated).
|
|
|
|
```diff
|
|
# vite.config.ts
|
|
|
|
electron({
|
|
- renderer: {}
|
|
})
|
|
```
|
|
|
|
## ❔ FAQ
|
|
|
|
- [dependencies vs devDependencies](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#dependencies-vs-devdependencies)
|
|
- [Using C/C++ native addons in Electron-Renderer](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#load-nodejs-cc-native-modules)
|
|
- [Node.js ESM packages](https://github.com/electron-vite/vite-plugin-electron/tree/main/packages/electron-renderer#nodejs-esm-packages) (e.g. `execa` `node-fetch`)
|