electron-vite-vue/README.md
2022-07-10 19:09:15 +08:00

2.4 KiB

electron-vite-vue

🥳 Really simple Electron + Vue + Vite boilerplate.

awesome-vite Netlify Status GitHub license GitHub stars GitHub forks

Features

📦 Out of the box
🎯 Based on the official 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

npm create electron-vite

electron-vite-vue.gif

Debug

electron-vite-react-debug.gif

Directory

+ ├─┬ electron
+ │ ├─┬ main
+ │ │ └── index.ts    entry of Electron-main
+ │ └─┬ preload
+ │   └── index.ts    entry of Electron-preload
  ├─┬ src
  │ └── main.ts       entry of Electron-renderer
  ├── index.html
  ├── package.json
  └── vite.config.ts

🚨 dependencies vs devDependencies

Put Node.js packages in dependencies

e.g. electron-store sqlite3 serilaport mongodb ...others

Put Web packages in devDependencies

e.g. vue vue-router vuex pinia element-plus ant-design-vue axios ...others

See more 👉 dependencies vs devDependencies

🚨 Node.js ESM packages

e.g. node-fetch execa got ...

👉 Using Node.js ESM packages in Electron-Renderer