Question 1

How to add a new npm package to the renderer in Vite Electron Builder?

Accepted Answer

Since the renderer is a standard Vite project, install packages in the renderer package directory using npm or yarn. Ensure they are browser-compatible, as Node.js APIs are restricted to the preload script to avoid crashes.

Question 2

Vite Electron Builder or electron-vite: which should I use?

Accepted Answer

Vite Electron Builder focuses on security best practices, a monorepo structure, and auto-updates out-of-the-box, while electron-vite is more lightweight. Choose based on whether you need built-in testing and CI/CD workflows versus a simpler setup.

Question 3

Can I use Next.js with this Electron template?

Accepted Answer

No, the template is designed for Vite-based renderers. Next.js uses different bundling and server-side rendering, which isn't directly supported; you'd need significant modifications to integrate it with the monorepo.

Question 4

How to configure auto-updates for a private repository or custom server?

Accepted Answer

The template defaults to GitHub Releases, but you can modify the electron-builder configuration in package.json to use other sources like S3 or private servers, following electron-builder's publish options documentation.

Question 5

What's the best way to handle native Node.js modules in the renderer?

Accepted Answer

Native Node.js modules cannot be used directly in the renderer due to security restrictions. Export functions from the preload script using contextBridge, as shown in the README example for file system access, to safely expose capabilities.

Question 6

Does this boilerplate support hot-reload for changes in the main process?

Accepted Answer

Hot-reload is primarily for the renderer via Vite. Changes in the main or preload processes require restarting the app, as Electron's main process doesn't support live reloading by default in this setup.

vite-electron-builder

What is vite-electron-builder?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions