mirror of
https://github.com/electron-vite/electron-vite-vue
synced 2024-10-12 23:46:44 +08:00
67 lines
3.0 KiB
Markdown
67 lines
3.0 KiB
Markdown
# electron-vite-vue
|
|
|
|
🥳 Really simple `Electron` + `Vue` + `Vite` boilerplate.
|
|
|
|
[](https://github.com/vitejs/awesome-vite)
|
|
[](https://app.netlify.com/sites/electron-vite/deploys)
|
|
[](https://github.com/electron-vite/electron-vite-vue/blob/main/LICENSE)
|
|
[](https://github.com/electron-vite/electron-vite-vue)
|
|
[](https://github.com/electron-vite/electron-vite-vue)
|
|
[](https://github.com/electron-vite/electron-vite-vue/actions/workflows/build.yml)
|
|
|
|
## Features
|
|
|
|
📦 Out of the box
|
|
🎯 Based on the official [vue-ts](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-vue-ts) template, less invasive
|
|
🌱 Extensible, really simple directory structure
|
|
💪 Support using Node.js API in Electron-Renderer
|
|
🔩 Support C/C++ native addons
|
|
🖥 It's easy to implement multiple windows
|
|
|
|
## Quick Start
|
|
|
|
```sh
|
|
npm create electron-vite
|
|
```
|
|
|
|
<!-- [](https://asciinema.org/a/483731) -->
|
|
|
|
|
|
|
|
## Debug
|
|
|
|
|
|
|
|
## Directory
|
|
|
|
```diff
|
|
+ ├─┬ electron
|
|
+ │ ├─┬ main
|
|
+ │ │ └── index.ts entry of Electron-Main
|
|
+ │ └─┬ preload
|
|
+ │ └── index.ts entry of Preload-Scripts
|
|
├─┬ src
|
|
│ └── main.ts entry of Electron-Renderer
|
|
├── index.html
|
|
├── package.json
|
|
└── vite.config.ts
|
|
```
|
|
|
|
## 🚨 Be aware
|
|
|
|
By default, this template integrates Node.js in the Renderer process. If you don't need it, you just remove the option below. [Because it will modify the default config of Vite](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`)
|