alex8088 / electron-vite-boilerplate

Comprehensive and security Electron template (TypeScript + Vue3 + Vite).

electron-app

An Electron application with Vue3 and TypeScript

Features

• 💡 Optimize asset handling
• 🚀 Fast HMR for renderer processes
• 🔥 Hot reloading for main process and preload scripts
• 🔌 Easy to debug
• 🔒 Compile to v8 bytecode to protect source code

Getting Started

Read documentation for more details.

• Configuring
• Development
• Asset Handling
• HMR & Hot Reloading
• Debugging
• Source code protection
• Distribution
• Troubleshooting

You can also use the create-electron tool to scaffold your project for other frameworks (e.g. React, Svelte or Solid).

Recommended IDE Setup

• VSCode + ESLint + Prettier + Volar + TypeScript Vue Plugin (Volar)

Project Setup

Install

$ npm install

Development

$ npm run dev

Build

# For windows
$ npm run build:win

# For macOS
$ npm run build:mac

# For Linux
$ npm run build:linux

Examples

• electron-vite-bytecode-example, source code protection
• electron-vite-decorator-example, typescipt decorator
• electron-vite-worker-example, worker and fork