{"id":20042730,"url":"https://github.com/documize/vite-electron-builder","last_synced_at":"2026-05-13T00:04:21.101Z","repository":{"id":93611535,"uuid":"354865891","full_name":"documize/vite-electron-builder","owner":"documize","description":null,"archived":false,"fork":false,"pushed_at":"2021-04-05T14:41:22.000Z","size":172,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-02T07:18:56.585Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/documize.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":".github/FUNDING.yml","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},"funding":{"patreon":"Kozack","open_collective":"vite-electron-builder"}},"created_at":"2021-04-05T14:41:20.000Z","updated_at":"2021-04-05T14:41:25.000Z","dependencies_parsed_at":"2023-03-04T10:45:28.881Z","dependency_job_id":null,"html_url":"https://github.com/documize/vite-electron-builder","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"cawa-93/vite-electron-builder","purl":"pkg:github/documize/vite-electron-builder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documize%2Fvite-electron-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documize%2Fvite-electron-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documize%2Fvite-electron-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documize%2Fvite-electron-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/documize","download_url":"https://codeload.github.com/documize/vite-electron-builder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documize%2Fvite-electron-builder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32961791,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-12T23:30:32.555Z","status":"ssl_error","status_checked_at":"2026-05-12T23:30:18.191Z","response_time":102,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-11-13T10:53:02.339Z","updated_at":"2026-05-13T00:04:21.084Z","avatar_url":"https://github.com/documize.png","language":"JavaScript","funding_links":["https://patreon.com/Kozack","https://opencollective.com/vite-electron-builder","https://www.patreon.com/Kozack/"],"categories":[],"sub_categories":[],"readme":"# Vite Electron Builder Boilerplate v2\n\n\u003e Vite+Electron = 🔥\n\nThis is a secure template for electron applications. Written following the latest safety requirements, recommendations and best practices.\n\nUnder the hood is used [Vite] — super fast, nextgen bundler, and [electron-builder] for compilation.\n\n\n___\n### Support\n- This template maintained by [Alex Kozack][cawa-93-github]. You can [💖 sponsor him][cawa-93-sponsor] for continued development of this template.\n\n- Found a problem? Pull requests are welcome.\n\n- If you have ideas, questions or suggestions - **Welcome to [discussions](https://github.com/cawa-93/vite-electron-builder/discussions)**. 😊\n___\n\n\n\n\n## Get started\n\n### Requirements\n- **node**: \u003e= v14\n- **npm**: \u003e= v7.7\n\n### Installation\nFollow these steps to get started with this template:\n\n1. Click the **[Use this template](https://github.com/cawa-93/vite-electron-builder/generate)** button.\n    \n   **Note**: Only the `main` branch matters. You do not need to include any other branches when creating the repository.\n   \nThat's all you need. 😉\n\n## Features\n\n### Electron [![Electron version](https://img.shields.io/github/package-json/dependency-version/cawa-93/vite-electron-builder/dev/electron?label=%20)][electron]\n- Template use the latest electron version with all the latest security patches.\n- The architecture of the application is built according to the security [guids](https://www.electronjs.org/docs/tutorial/security) and best practices.\n- The latest version of the [electron-builder] is used to compile the application.\n\n\n### Vite [![Vite version](https://img.shields.io/github/package-json/dependency-version/cawa-93/vite-electron-builder/dev/vite?label=%20)][vite]\n- [Vite] is used to bundle all source codes. This is an extremely fast packer that has a bunch of great features. You can learn more about how it is arranged in [this](https://youtu.be/xXrhg26VCSc) video.\n- Vite [supports](https://vitejs.dev/guide/env-and-mode.html) reading `.env` files. My template has a separate command to generate `.d.ts` file with type definition your environment variables.\n\nVite provides you with many useful features, such as: `TypeScript`, `TSX/JSX`, `CSS/JSON Importing`, `CSS Modules`, `Web Assembly` and much more.\n\n[See all Vite features](https://vitejs.dev/guide/features.html).\n\n\n### TypeScript [![TypeScript version](https://img.shields.io/github/package-json/dependency-version/cawa-93/vite-electron-builder/dev/typescript?label=%20)][typescript] (optional)\n- The Latest TypeScript is used for all source code. \n- **Vite** supports TypeScript out of the box. However, it does not support type checking.\n- Code formatting rules follow the latest TypeScript recommendations and best practices thanks to [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin).\n\n**Note**: If you do not need a TypeScript, you can easily abandon it. To do this, You do not need to make any bundler configuration changes, etc. Just replace all `.ts` files with `.js` files. Additionally, it will be useful to delete TS-specific files, plug-ins and dependencies like `tsconfig.json`, `@typescript-eslint/*`, etc.\n\n\n### Vue [![Vue version](https://img.shields.io/github/package-json/dependency-version/cawa-93/vite-electron-builder/vue?label=%20)][vue] (optional)\n- By default, web pages are built using [Vue]. However, you can easily change it. Or do not use additional frameworks at all. (See [React fork](https://github.com/soulsam480/vite-electron-react-starter))\n- Also, by default, the [vue-router] version [![Vue-router version](https://img.shields.io/github/package-json/dependency-version/cawa-93/vite-electron-builder/vue-router?label=%20)][vue-router] is used.\n- Code formatting rules follow the latest Vue recommendations and best practices thanks to [eslint-plugin-vue].\n- Installed [Vue.js devtools beta](https://chrome.google.com/webstore/detail/vuejs-devtools/ljjemllljcmogpfapbkkighbhhppjdbg) with Vue 3 support.\n\nSee [examples of web pages for different frameworks](https://github.com/vitejs/vite/tree/main/packages/create-app).\n\n### Continuous Integration\n- The configured workflow for check the types for each push and PR.\n- The configured workflow for check the code style for each push and PR.\n- **Automatic tests** used [spectron]. Simple, automated test check:\n  - Does the main window created and visible?\n  - Is the main window not empty?\n  - Is dev tools closed?\n  \n\n### Continuous delivery\n- Each time you push changes to the `main` branch, [`release`](.github/workflows/release.yml) workflow starts, which creates release draft.\n  - The version is automatically set based on the current date in the format \"yy.mm.dd\".\n  - Notes are automatically generated and added to the release draft.\n  - Code signing supported. See [`compile` job in `release` workflow](.github/workflows/release.yml).\n- **Auto-update is supported**. After the release will be published, all client applications will download the new version and install updates silently.\n\n\n## Status — WIP\n\nThis template was created to make my work easier. It may not be universal, but I try to keep it that way.\n\nI am actively involved in its development. But I do not guarantee that this template will be maintained in the future.\n\n\n**At the moment, there are the following problems:**\n\n- ⚠ Some files require refactoring.\n- ⚠ Watch mode for the `main` and `preload` entry points should be improved. Blocked by  [vite#1434](https://github.com/vitejs/vite/issues/1434).\n- ⚠ Typechecking `renderer` package in CI implemented by [![vue-tsc](https://img.shields.io/github/package-json/dependency-version/cawa-93/vite-electron-builder/dev/vue-tsc)][vue-tsc], which has a very early version. This is not a problem if you do not use Vue or TypeScript.\n- ⚠ Release notes are created automatically based on commit history. [`scripts/release-notes.js`](scripts/release-notes.js) is used for generation. It may not provide some scenarios. If you encounter a problem - write about it.\n- ⏳ I want to migrate all code base to ESM. But because Nodejs  ecosystem is unprepared I not known whether this will give more benefits or more inconvenience.\n\nSome improvement or problems can be listed in [issues](https://github.com/cawa-93/vite-electron-builder/issues).\n\n**Pull requests are welcome**.\n\n## How it works\nThe template required a minimum [dependencies](package.json). Only **Vite** is used for building, nothing more.\n\n### Project Structure\n\nThe structure of this template is very similar to the structure of a monorepo.\n\nThe entire source code of the program is divided into three modules (packages) that are bundled each independently:\n- [`packages/main`](packages/main)\nElectron [**main script**](https://www.electronjs.org/docs/tutorial/quick-start#create-the-main-script-file).\n- [`packages/preload`](packages/preload)\nUsed in `BrowserWindow.webPreferences.preload`. See [Checklist: Security Recommendations](https://www.electronjs.org/docs/tutorial/security#2-do-not-enable-nodejs-integration-for-remote-content).\n- [`packages/renderer`](packages/renderer)\nElectron [**web page**](https://www.electronjs.org/docs/tutorial/quick-start#create-a-web-page).\n\n### Build web resources\n\nPackages `main` and `preload` are built in [library mode](https://vitejs.dev/guide/build.html#library-mode) as it is a simple javascript.\n`renderer` package build as regular web app.\n\nThe build of web resources is performed in the [`scripts/build.js`](scripts/build.js). Its analogue is a sequential call to `vite build` for each package.\n\n### Compile App\nNext step is run  packaging and compilation a ready for distribution Electron app for macOS, Windows and Linux with \"auto update\" support out of the box. \n\nTo do this, using the [electron-builder]:\n- In npm script `compile`: This script is configured to compile the application as quickly as possible. It is not ready for distribution, is compiled only for the current platform and is used for debugging.\n- In GitHub Action: The application is compiled for any platform and ready-to-distribute files are automatically added to the draft GitHub release. \n\n\n### Using electron API in renderer\nAs per the security requirements, context isolation is enabled in this template.\n\u003e Context Isolation is a feature that ensures that both your `preload` scripts and Electron's internal logic run in a separate context to the website you load in a [`webContents`](https://github.com/electron/electron/blob/master/docs/api/web-contents.md).  This is important for security purposes as it helps prevent the website from accessing Electron internals, or the powerful APIs your preload script has access to.\n\u003e\n\u003e This means that the `window` object that your preload script has access to is actually a **different** object than the website would have access to.  For example, if you set `window.hello = 'wave'` in your preload script and context isolation is enabled `window.hello` will be undefined if the website tries to access it.\n\n[Read more about Context Isolation](https://github.com/electron/electron/blob/master/docs/tutorial/context-isolation.md).\n\nExposing APIs from your `preload script` to the renderer is a common use case and there is a dedicated module in Electron to help you do this in a painless way.\n```ts\n// packages/preload/src/index.ts\nconst api = {\n  data: ['foo', 'bar'],\n  doThing: () =\u003e ipcRenderer.send('do-a-thing')\n}\n\ncontextBridge.exposeInMainWorld('electron', api)\n```\n\nTo access this API use the `useElectron()` function:\n```ts\n// packages/renderer/src/App.vue\nimport {useElectron} from '/@/use/electron'\n\nconst {doThing, data} = useElectron()\n```\n\n**Note**: Context isolation disabled for `test` environment. See [#693](https://github.com/electron-userland/spectron/issues/693#issuecomment-747872160).\n\n\n\n### Modes and Environment Variables\nAll environment variables set as part of the `import.meta`, so you can access them as follows: `import.meta.env`. \n\nYou can also build type definitions of your variables by running `scripts/buildEnvTypes.js`. This command will create `types/env.d.ts` file with describing all environment variables for all modes.\n\nThe mode option is used to specify the value of `import.meta.env.MODE` and the corresponding environment variables files that needs to be loaded.\n\nBy default, there are two modes:\n  - `production` is used by default\n  - `development` is used by `npm run watch` script\n  - `test` is used by `npm test` script\n\nWhen running building, environment variables are loaded from the following files in your project root:\n\n```\n.env                # loaded in all cases\n.env.local          # loaded in all cases, ignored by git\n.env.[mode]         # only loaded in specified env mode\n.env.[mode].local   # only loaded in specified env mode, ignored by git\n```\n\n**Note:** only variables prefixed with `VITE_` are exposed to your code (e.g. `VITE_SOME_KEY=123`) and `SOME_KEY=123` will not.  you can access `VITE_SOME_KEY` using `import.meta.env.VITE_SOME_KEY`. This is because the `.env` files may be used by some users for server-side or build scripts and may contain sensitive information that should not be exposed in code shipped to browsers.\n\n\n\n## Contribution\n\nSee [Contributing Guide](contributing.md).\n\n\n[vite]: https://github.com/vitejs/vite/\n[electron]: https://github.com/electron/electron\n[electron-builder]: https://github.com/electron-userland/electron-builder\n[vue]: https://github.com/vuejs/vue-next\n[vue-router]: https://github.com/vuejs/vue-router-next/\n[typescript]: https://github.com/microsoft/TypeScript/\n[spectron]: https://github.com/electron-userland/spectron\n[vue-tsc]: https://github.com/johnsoncodehk/vue-tsc\n[eslint-plugin-vue]: https://github.com/vuejs/eslint-plugin-vue\n[cawa-93-github]: https://github.com/cawa-93/\n[cawa-93-sponsor]: https://www.patreon.com/Kozack/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocumize%2Fvite-electron-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocumize%2Fvite-electron-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocumize%2Fvite-electron-builder/lists"}