nuxt-electron

Nuxt Electron

Integrate Nuxt and Electron

Features

• 🚀 High-performance (Not Bundle, based on esbuild)
• 📦 Out of the box
• 🔥 Hot restart

Quick Setup

• Add the following dependency to your project

npm i -D nuxt-electron vite-electron-plugin electron electron-builder

• Add nuxt-electron to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    ['nuxt-electron'],
  ],
})

That's it! You can now use Electron in your Nuxt app ✨

Recommend structure

Let's use the official nuxt-starter-v3 template as an example

+ ├─┬ electron
+ │ └── main.ts
  ├─┬ public
  │ └── favicon.ico
  ├── .gitignore
  ├── .npmrc
  ├── index.html
  ├── app.vue
  ├── nuxt.config.ts
  ├── package.json
  ├── README.md
  └── tsconfig.json

ElectronOptions

This is based on the vite-electron-plugin, see the Documents for more detailed options

Here is the default nuxt-electron options

import type { ElectronOptions } from 'nuxt-electron'

export default defineNuxtConfig({
  modules: [
    ['nuxt-electron', <ElectronOptions>{
      include: ['electron'],
      outDir: 'dist-electron',
    }],
  ],
})

Examples

• quick-start
• nuxt-electron-trpc-prisma

Notes

By default, we force the App to run in SPA mode since we don't need SSR for desktop apps

Changelog

0.4.0 (2023-02-15)

Main Changed

• a48a15a feat: add meta, better default options