{"id":29618830,"url":"https://github.com/olaalsaker/nuxt-electron-next","last_synced_at":"2026-01-20T16:47:53.452Z","repository":{"id":305130212,"uuid":"1022060089","full_name":"OlaAlsaker/nuxt-electron-next","owner":"OlaAlsaker","description":"Fork of nuxt-electron, updated to work with Nuxt 4","archived":false,"fork":false,"pushed_at":"2025-07-18T12:05:58.000Z","size":265,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-18T14:09:07.917Z","etag":null,"topics":["electron","nuxt","nuxt-electron"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OlaAlsaker.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-18T11:39:49.000Z","updated_at":"2025-07-18T12:05:24.000Z","dependencies_parsed_at":"2025-07-18T14:11:31.547Z","dependency_job_id":"fb6eb316-1562-40ab-b6f7-ecb168e26260","html_url":"https://github.com/OlaAlsaker/nuxt-electron-next","commit_stats":null,"previous_names":["olaalsaker/nuxt-electron-next"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/OlaAlsaker/nuxt-electron-next","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlaAlsaker%2Fnuxt-electron-next","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlaAlsaker%2Fnuxt-electron-next/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlaAlsaker%2Fnuxt-electron-next/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlaAlsaker%2Fnuxt-electron-next/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OlaAlsaker","download_url":"https://codeload.github.com/OlaAlsaker/nuxt-electron-next/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OlaAlsaker%2Fnuxt-electron-next/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266231762,"owners_count":23896472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","nuxt","nuxt-electron"],"created_at":"2025-07-21T03:00:33.692Z","updated_at":"2025-11-05T21:02:57.722Z","avatar_url":"https://github.com/OlaAlsaker.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"170\" src=\"https://github.com/OlaAlsaker/nuxt-electron-next/raw/main/logo.svg?raw=true\"\u003e\n\u003c/p\u003e\n\n# Nuxt Electron (Next)\n\nIntegrate Nuxt 4 and Electron\n\n\u003e [!NOTE]\n\u003e **This is a fork of [nuxt-electron](https://github.com/caoxiemeihao/nuxt-electron) that is updated to work with Nuxt 4.**\n\n## Features\n\n- 📦 Out of the box\n- 🔥 Hot restart \u003csub\u003e\u003csup\u003e(Main process)\u003c/sup\u003e\u003c/sub\u003e\n- 🚀 Hot reload \u003csub\u003e\u003csup\u003e(Preload script)\u003c/sup\u003e\u003c/sub\u003e\n\n## Quick Setup\n\n\n1. Install the package and the following dependencies to your project\n\n```sh\n# Using pnpm\npnpm add -D nuxt-electron-next vite-plugin-electron vite-plugin-electron-renderer electron electron-builder\n\n# Using yarn\nyarn add --dev nuxt-electron-next vite-plugin-electron vite-plugin-electron-renderer electron electron-builder\n\n# Using npm\nnpm install --save-dev nuxt-electron-next vite-plugin-electron vite-plugin-electron-renderer electron electron-builder\n```\n\n2. Update your `nuxt.config.ts`\n\n```ts\nexport default defineNuxtConfig({\n  modules: ['nuxt-electron-next'],\n  electron: {\n    build: [\n      {\n        // Main-Process entry file of the Electron App.\n        entry: 'electron/main.ts',\n      },\n    ],\n  },\n  ssr: false,\n  ...\n})\n```\n\n3. Create the `electron/main.ts` file and type the following code\n\n```ts\nimport { app, BrowserWindow } from 'electron'\n\napp.whenReady().then(() =\u003e {\n  new BrowserWindow().loadURL(process.env.VITE_DEV_SERVER_URL)\n})\n```\n\n4. Add the `main` entry to `package.json`\n\n```diff\n{\n+ \"main\": \"dist-electron/main.js\"\n}\n```\n\nThat's it! You can now use Electron in your Nuxt app ✨\n\n## Electron Options\n\n\u003e This is based on the `vite-plugin-electron`, see the **[Documents](https://github.com/electron-vite/vite-plugin-electron)** for more detailed options\n\n```ts\nexport interface ElectronOptions {\n  /**\n   * `build` can specify multiple entry builds, which can be Main process, Preload scripts, Worker process, etc.\n   * \n   * @example\n   * \n   * ```js\n   * export default defineNuxtConfig({\n   *   modules: ['nuxt-electron-next'],\n   *   electron: {\n   *     build: [\n   *       {\n   *         // Main-Process entry file of the Electron App.\n   *         entry: 'electron/main.ts',\n   *       },\n   *     ],\n   *   },\n   * })\n   * ```\n   */\n  build: import('vite-plugin-electron').ElectronOptions[],\n  /**\n   * @see https://github.com/electron-vite/vite-plugin-electron-renderer\n   */\n  renderer?: Parameters\u003ctypeof import('vite-plugin-electron-renderer').default\u003e[0]\n  /**\n   * nuxt-electron will modify some options by default\n   * \n   * @defaultValue\n   * \n   * ```js\n   * export default defineNuxtConfig({\n   *   ssr: false,\n   *   app: {\n   *     baseURL: './',\n   *     buildAssetsDir: '/',\n   *   },\n   *   runtimeConfig: {\n   *     app: {\n   *       baseURL: './',\n   *       buildAssetsDir: '/',\n   *     },\n   *   },\n   *   nitro: {\n   *     runtimeConfig: {\n   *       app: {\n   *         baseURL: './,\n   *       }\n  *      }\n   *   },\n      router: {\n        options: {\n          hashMode: true,\n        }\n      }\n   * })\n   * ```\n   */\n  disableDefaultOptions?: boolean\n}\n```\n\n## Recommend Structure\n\n```diff\n+ ├─┬ electron\n+ │ └── main.ts\n  ├─┬ public\n  │ └── favicon.ico\n  ├── .gitignore\n  ├── .npmrc\n  ├── index.html\n  ├── app.vue\n  ├── nuxt.config.ts\n  ├── package.json\n  ├── README.md\n  └── tsconfig.json\n```\n\n## Examples\n\n- [quick-start](https://github.com/OlaAlsaker/nuxt-electron-next/tree/main/quick-start)\n\n## Notes\nBy default, we force the App to run in SPA mode since we don't need SSR for desktop apps\n\nIf you want to fully customize the default behavior, you can disable it by `disableDefaultOptions`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folaalsaker%2Fnuxt-electron-next","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Folaalsaker%2Fnuxt-electron-next","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folaalsaker%2Fnuxt-electron-next/lists"}