{"id":13417121,"url":"https://github.com/electron-vite/electron-vite-react","last_synced_at":"2025-10-05T01:25:44.196Z","repository":{"id":37452650,"uuid":"423712737","full_name":"electron-vite/electron-vite-react","owner":"electron-vite","description":":electron: Electron + Vite + React + Sass boilerplate.","archived":false,"fork":false,"pushed_at":"2024-11-17T11:35:25.000Z","size":14964,"stargazers_count":2126,"open_issues_count":46,"forks_count":269,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-04-11T03:38:08.968Z","etag":null,"topics":["electron","nodejs","react","sass","typescript","vite"],"latest_commit_sha":null,"homepage":"https://electron-vite.github.io","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/electron-vite.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2021-11-02T05:02:59.000Z","updated_at":"2025-04-11T03:14:46.000Z","dependencies_parsed_at":"2024-01-12T23:37:06.633Z","dependency_job_id":"10bdfc87-b9f9-4c7e-b595-f306f85051ce","html_url":"https://github.com/electron-vite/electron-vite-react","commit_stats":{"total_commits":409,"total_committers":21,"mean_commits":"19.476190476190474","dds":"0.14180929095354522","last_synced_commit":"190492b3f2406ece08a4d25dbebd8b7ae5b16b5d"},"previous_names":[],"tags_count":3,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-vite%2Felectron-vite-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-vite%2Felectron-vite-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-vite%2Felectron-vite-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-vite%2Felectron-vite-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electron-vite","download_url":"https://codeload.github.com/electron-vite/electron-vite-react/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254076848,"owners_count":22010611,"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","nodejs","react","sass","typescript","vite"],"created_at":"2024-07-30T22:00:32.727Z","updated_at":"2025-10-05T01:25:39.174Z","avatar_url":"https://github.com/electron-vite.png","language":"TypeScript","readme":"# electron-vite-react\n\n[![awesome-vite](https://awesome.re/mentioned-badge.svg)](https://github.com/vitejs/awesome-vite)\n![GitHub stars](https://img.shields.io/github/stars/caoxiemeihao/vite-react-electron?color=fa6470)\n![GitHub issues](https://img.shields.io/github/issues/caoxiemeihao/vite-react-electron?color=d8b22d)\n![GitHub license](https://img.shields.io/github/license/caoxiemeihao/vite-react-electron)\n[![Required Node.JS \u003e= 14.18.0 || \u003e=16.0.0](https://img.shields.io/static/v1?label=node\u0026message=14.18.0%20||%20%3E=16.0.0\u0026logo=node.js\u0026color=3f893e)](https://nodejs.org/about/releases)\n\nEnglish | [简体中文](README.zh-CN.md)\n\n## 👀 Overview\n\n📦 Ready out of the box  \n🎯 Based on the official [template-react-ts](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts), project structure will be familiar to you  \n🌱 Easily extendable and customizable  \n💪 Supports Node.js API in the renderer process  \n🔩 Supports C/C++ native addons  \n🐞 Debugger configuration included  \n🖥 Easy to implement multiple windows  \n\n## 🛫 Quick Setup\n\n```sh\n# clone the project\ngit clone https://github.com/electron-vite/electron-vite-react.git\n\n# enter the project directory\ncd electron-vite-react\n\n# install dependency\nnpm install\n\n# develop\nnpm run dev\n```\n\n## 🐞 Debug\n\n![electron-vite-react-debug.gif](/electron-vite-react-debug.gif)\n\n## 📂 Directory structure\n\nFamiliar React application structure, just with `electron` folder on the top :wink:  \n*Files in this folder will be separated from your React application and built into `dist-electron`*  \n\n```tree\n├── electron                                 Electron-related code\n│   ├── main                                 Main-process source code\n│   └── preload                              Preload-scripts source code\n│\n├── release                                  Generated after production build, contains executables\n│   └── {version}\n│       ├── {os}-{os_arch}                   Contains unpacked application executable\n│       └── {app_name}_{version}.{ext}       Installer for the application\n│\n├── public                                   Static assets\n└── src                                      Renderer source code, your React application\n```\n\n\u003c!--\n## 🚨 Be aware\n\nThis template integrates Node.js API to the renderer process by default. If you want to follow **Electron Security Concerns** you might want to disable this feature. You will have to expose needed API by yourself.  \n\nTo get started, remove the option as shown below. This will [modify the Vite configuration and disable this feature](https://github.com/electron-vite/vite-plugin-electron-renderer#config-presets-opinionated).\n\n```diff\n# vite.config.ts\n\nexport default {\n  plugins: [\n    ...\n-   // Use Node.js API in the Renderer-process\n-   renderer({\n-     nodeIntegration: true,\n-   }),\n    ...\n  ],\n}\n```\n--\u003e\n\n## 🔧 Additional features\n\n1. electron-updater 👉 [see docs](src/components/update/README.md)\n1. playwright\n\n## ❔ FAQ\n\n- [C/C++ addons, Node.js modules - Pre-Bundling](https://github.com/electron-vite/vite-plugin-electron-renderer#dependency-pre-bundling)\n- [dependencies vs devDependencies](https://github.com/electron-vite/vite-plugin-electron-renderer#dependencies-vs-devdependencies)\n","funding_links":[],"categories":["Get Started","TypeScript"],"sub_categories":["Templates"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron-vite%2Felectron-vite-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectron-vite%2Felectron-vite-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron-vite%2Felectron-vite-react/lists"}