-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
47d59dd
commit bcc5c4d
Showing
3 changed files
with
3 additions
and
93 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,91 +1 @@ | ||
# electron-vite-react | ||
|
||
[![awesome-vite](https://awesome.re/mentioned-badge.svg)](https://github.com/vitejs/awesome-vite) | ||
![GitHub stars](https://img.shields.io/github/stars/caoxiemeihao/vite-react-electron?color=fa6470) | ||
![GitHub issues](https://img.shields.io/github/issues/caoxiemeihao/vite-react-electron?color=d8b22d) | ||
![GitHub license](https://img.shields.io/github/license/caoxiemeihao/vite-react-electron) | ||
[![Required Node.JS >= 14.18.0 || >=16.0.0](https://img.shields.io/static/v1?label=node&message=14.18.0%20||%20%3E=16.0.0&logo=node.js&color=3f893e)](https://nodejs.org/about/releases) | ||
|
||
English | [简体中文](README.zh-CN.md) | ||
|
||
## 👀 Overview | ||
|
||
📦 Ready out of the box | ||
🎯 Based on the official [template-react-ts](https://github.com/vitejs/vite/tree/main/packages/create-vite/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 | ||
|
||
```sh | ||
# 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](/electron-vite-react-debug.gif) | ||
|
||
## 📂 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 | ||
│ | ||
├── 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 | ||
``` | ||
|
||
<!-- | ||
## 🚨 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 feature. You will have 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-renderer#config-presets-opinionated). | ||
```diff | ||
# vite.config.ts | ||
export default { | ||
plugins: [ | ||
... | ||
- // Use Node.js API in the Renderer-process | ||
- renderer({ | ||
- nodeIntegration: true, | ||
- }), | ||
... | ||
], | ||
} | ||
``` | ||
--> | ||
|
||
## 🔧 Additional features | ||
|
||
1. electron-updater 👉 [see docs](src/components/update/README.md) | ||
1. playwright | ||
|
||
## ❔ FAQ | ||
|
||
- [C/C++ addons, Node.js modules - Pre-Bundling](https://github.com/electron-vite/vite-plugin-electron-renderer#dependency-pre-bundling) | ||
- [dependencies vs devDependencies](https://github.com/electron-vite/vite-plugin-electron-renderer#dependencies-vs-devdependencies) | ||
v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -62,6 +62,6 @@ | |
"zustand": "^4.4.3" | ||
}, | ||
"engines": { | ||
"node": "^14.18.0 || >=16.0.0" | ||
"node": ">=16.0.0" | ||
} | ||
} |