electron-vue-vite

English | 简体中文

🥳 Very simple Electron + Vue3 + Vite2 boilerplate.

Run Setup

# clone the project
git clone git@github.com:caoxiemeihao/electron-vue-vite.git

# enter the project directory
cd electron-vue-vite

# install dependency
npm install

# develop
npm run dev

Directory

├
├── configs
├   ├── vite-main.config.ts          Main-process config file, for -> src/main
├   ├── vite-preload.config.ts       Preload-script config file, for -> src/preload
├   ├── vite-renderer.config.ts      Renderer-script config file, for -> src/renderer
├
├── scripts
├   ├── build.mjs                    Build script, for -> npm run build
├   ├── electron-builder.config.mjs
├   ├── watch.mjs                    Develop script, for -> npm run dev
├
├── src
├   ├── main                         Main-process source code
├   ├── preload                      Preload-script source code
├   ├── renderer                     Renderer-process source code
├

dist and src

• Once npm run dev or npm run build is executed. Will be generated dist, it is the same as the src structure.

• This ensures the accuracy of path calculation.

├── dist
├   ├── main
├   ├── preload
├   ├── renderer
├── src
├   ├── main
├   ├── preload
├   ├── renderer
├

Use Electron, NodeJs API

🚧 By default, Electron don't support the use of API related to Electron and NoeJs in the Renderer-process, but someone still need to use it. If so, you can see the 👉 npm-package vitejs-plugin-electron or another template vite-webpack-electron

All Electron, NodeJs API invoke passed Preload-script

• src/preload/index.ts

  import fs from 'fs'
  import { contextBridge, ipcRenderer } from 'electron'
  
  // --------- Expose some API to Renderer-process. ---------
  contextBridge.exposeInMainWorld('fs', fs)
  contextBridge.exposeInMainWorld('ipcRenderer', ipcRenderer)
  

• src/renderer/src/main.ts

  console.log('fs', window.fs)
  console.log('ipcRenderer', window.ipcRenderer)
  

Mian window

Wechat