Contents
Vite+Vue3+Electron+Typescript template
Get Started
1. clone this repository
2. install packages
3. run
How to create this template?
1. create Vite project
2. Install electron and concurrently
3. setup electron
Create file src/electron/main/main.ts and src/electron/preload/preload.ts
// src/electron/main/main.ts
import { join } from ‘path’;
import {
app,
BrowserWindow
} from ‘electron’;
const isDev = process.env.npm_lifecycle_event === “app:dev” ? true : false;
function createWindow() {
// Create the browser window.
const mainWindow = new BrowserWindow({
width: 800,
height: 600,
webPreferences: {
preload: join(__dirname, ‘../preload/preload.js’),
},
});
// and load the index.html of the app.
mainWindow.loadURL(
isDev ?
‘http://localhost:3000’ :
join(__dirname, ‘../../index.html’)
);
// Open the DevTools.
if (isDev) {
mainWindow.webContents.openDevTools();
}
}
// This method will be called when Electron has finished
// initialization and is ready to create browser windows.
// Some APIs can only be used after this event occurs.
app.whenReady().then(() => {
createWindow()
app.on(‘activate’, function () {
// On macOS it’s common to re-create a window in the app when the
// dock icon is clicked and there are no other windows open.
if (BrowserWindow.getAllWindows().length === 0) createWindow()
})
});
// Quit when all windows are closed, except on macOS. There, it’s common
// for applications and their menu bar to stay active until the user quits
// explicitly with Cmd + Q.
app.on(‘window-all-closed’, () => {
if (process.platform !== ‘darwin’) {
app.quit();
}
});
// src/electron/preload/preload.ts
// All of the Node.js APIs are available in the preload process.
// It has the same sandbox as a Chrome extension.
window.addEventListener(‘DOMContentLoaded’, () => {
const replaceText = (selector:any, text:any) => {
const element = document.getElementById(selector)
if (element) element.innerText = text
}
for (const dependency of [‘chrome’, ‘node’, ‘electron’]) {
replaceText(`${dependency}-version`, process.versions[dependency])
}
})
4. Edit tsconfig.json
{
“compilerOptions”: {
“target”: “esnext”,
“useDefineForClassFields”: true,
“module”: “commonjs”,
“moduleResolution”: “node”,
“strict”: true,
“jsx”: “preserve”,
“sourceMap”: true,
“resolveJsonModule”: true,
“isolatedModules”: false,
“esModuleInterop”: true,
“lib”: [“esnext”, “dom”],
“skipLibCheck”: true,
“outDir”: “dist/electron”
},
“include”: [“src/electron/**/*”],
“references”: [{
“path”: “./tsconfig.node.json”
}]
}
5. Edit vite.config.ts
import { defineConfig } from ‘vite’
import vue from ‘@vitejs/plugin-vue’
// https://vitejs.dev/config/
export default defineConfig({
plugins: [vue()],
base: ‘./’ //add base path
})
6. Edit package.json
{
“name”: “vite-vue3-electron-ts-template“,
“private”: true,
“version”: “0.0.0“,
“author”: “Your Name“,
“main”: “dist/electron/main/main.js“,
“scripts”: {
“vite:dev”: “vite“,
“vite:build”: “vue-tsc –noEmit && vite build“,
“vite:preview”: “vite preview“,
“ts”: “tsc“,
“watch”: “tsc -w“,
“lint”: “eslint -c .eslintrc –ext .ts ./src“,
“app:dev”: “tsc && concurrently vite “ electron .“ “tsc -w““,
“app:build”: “npm run vite:build && tsc && electron-builder“,
“app:preview”: “npm run vite:build && tsc && electron .“
},
“build”: {
“appId”: “YourAppID“,
“asar”: true,
“directories”: {
“buildResources”: “assets“,
“output”: “release/${version}“
},
“files”: [
“dist“
],
“mac”: {
“artifactName”: “${productName}_${version}.${ext}“,
“target”: [
“dmg“
]
},
“win”: {
“target”: [{
“target”: “nsis“,
“arch”: [
“x64“
]
}],
“artifactName”: “${productName}_${version}.${ext}“
},
“nsis”: {
“oneClick”: false,
“perMachine”: false,
“allowToChangeInstallationDirectory”: true,
“deleteAppDataOnUninstall”: false
}
},
“dependencies”: {
“vue”: “^3.2.25“
},
“devDependencies”: {
“@vitejs/plugin-vue”: “^2.3.3“,
“concurrently”: “^7.2.2“,
“electron”: “^19.0.6“,
“electron-builder”: “^23.1.0“,
“typescript”: “^4.5.4“,
“vite”: “^2.9.9“,
“vue-tsc”: “^0.34.7“
}
}