{"id":16500381,"url":"https://github.com/caoxiemeihao/nuxt-electron","last_synced_at":"2025-05-15T21:04:40.491Z","repository":{"id":64230397,"uuid":"564125759","full_name":"caoxiemeihao/nuxt-electron","owner":"caoxiemeihao","description":"Integrate Nuxt and Electron","archived":false,"fork":false,"pushed_at":"2025-01-20T02:08:57.000Z","size":1044,"stargazers_count":203,"open_issues_count":28,"forks_count":22,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-12T06:07:10.121Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/caoxiemeihao.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}},"created_at":"2022-11-10T03:23:06.000Z","updated_at":"2025-05-10T13:41:44.000Z","dependencies_parsed_at":"2024-03-30T03:22:12.324Z","dependency_job_id":"f140b742-55cc-45b1-beb9-3885fbc602f1","html_url":"https://github.com/caoxiemeihao/nuxt-electron","commit_stats":{"total_commits":51,"total_committers":3,"mean_commits":17.0,"dds":"0.039215686274509776","last_synced_commit":"b7e047c80d226e8a362fb8014244f8a1591fd332"},"previous_names":["caoxiemeihao/nuxt-plugin-electron"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caoxiemeihao%2Fnuxt-electron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caoxiemeihao%2Fnuxt-electron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caoxiemeihao%2Fnuxt-electron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caoxiemeihao%2Fnuxt-electron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caoxiemeihao","download_url":"https://codeload.github.com/caoxiemeihao/nuxt-electron/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254422754,"owners_count":22068678,"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":[],"created_at":"2024-10-11T14:57:16.122Z","updated_at":"2025-05-15T21:04:40.459Z","avatar_url":"https://github.com/caoxiemeihao.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","Starter Kits"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"170\" src=\"https://github.com/caoxiemeihao/nuxt-electron/raw/main/logo.svg?raw=true\"\u003e\n\u003c/p\u003e\n\n# Nuxt Electron\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![License][license-src]][license-href]\n[\u003cimg src=\"https://api.gitsponsors.com/api/badge/img?id=564125759\" height=\"20\"\u003e](https://api.gitsponsors.com/api/badge/link?p=Mz9rvcT08fgHJXo5KS+hQ96a91PyIlbKcr11rzON3xux6OXDlmkpEtfDd/XpYlsw)\n\n\u003e Integrate Nuxt and Electron\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\n1. Add `electron` module to project\n\n```sh\nnpx nuxi module add electron\n```\n\n2. Add the following dependency to your project\n\n```sh\n# Using pnpm\npnpm add -D vite-plugin-electron vite-plugin-electron-renderer electron electron-builder\n\n# Using yarn\nyarn add --dev vite-plugin-electron vite-plugin-electron-renderer electron electron-builder\n\n# Using npm\nnpm install --save-dev vite-plugin-electron vite-plugin-electron-renderer electron electron-builder\n```\n\n3. Add `electron` and related config to `nuxt.config.ts`\n\n```ts\nexport default defineNuxtConfig({\n  ...\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, // #43\n  ...\n})\n```\n\n4. 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\n5. 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'],\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\nLet's use the official [nuxt-starter-v3](https://codeload.github.com/nuxt/starter/tar.gz/refs/heads/v3) template as an example\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/caoxiemeihao/nuxt-electron/tree/main/quick-start)\n- [nuxt-electron-trpc-prisma](https://github.com/gurvancampion/nuxt-electron-trpc-prisma)\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\n\u003c!-- Badges --\u003e\n[npm-version-src]: https://img.shields.io/npm/v/nuxt-electron/latest.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-version-href]: https://npmjs.com/package/nuxt-electron\n\n[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-electron.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-downloads-href]: https://npmjs.com/package/nuxt-electron\n\n[license-src]: https://img.shields.io/npm/l/nuxt-electron.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[license-href]: https://npmjs.com/package/nuxt-electron\n\n## TODO\n\n- [ ] write test\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaoxiemeihao%2Fnuxt-electron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaoxiemeihao%2Fnuxt-electron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaoxiemeihao%2Fnuxt-electron/lists"}