Repolode
electron-react-boilerplate

electron-react-boilerplate/electron-react-boilerplate

基于 Electron、React、TypeScript 和 Vite 的跨平台桌面应用起步模板。

Star
24,255
Fork
3,960
未关闭 Issue
11
最近提交
9天前

这是什么?

Electron React Boilerplate 是一个桌面应用起步模板,使用 Electron 搭配 React 渲染进程,可构建运行于 Windows、macOS 和 Linux 的应用。项目已集成 React Router、electron-vite 以及 React Fast Refresh,主进程、preload 与渲染进程的构建和热更新开箱即用,无需从零配置。

开发时执行一条命令即可构建主进程和 preload 代码、启动 Vite,并在源码变化时自动重载。打包由 electron-builder 完成,可生成当前平台的安装包。原生依赖单独放在 release/app/package.json 中,打包时重新编译;其他应用依赖则会被打包进产物。SVG 可以直接作为 React 组件导入,同时支持 CSS Modules 和 Sass。

项目要求 Node.js 24 及以上、npm 10 及以上版本。文档与指南位于官方网站,项目采用 MIT 许可证。

核心功能

  • 01集成 Electron 主进程与 React 渲染进程,并内置 React Router
  • 02基于 electron-vite 的开发服务器,支持热更新与 React Fast Refresh
  • 03通过 electron-builder 为当前平台生成安装包
  • 04SVG 可作为 React 组件导入,支持 CSS Modules 与 Sass
  • 05构建和打包时单独处理原生依赖

适用场景

  • 使用 React 与 TypeScript 启动一个新的跨平台桌面应用
  • 学习 Electron、Vite 与 React 在实际项目结构中的配合方式
  • 快速搭建需要开发期热更新的桌面工具原型

快速上手

  1. 1

    克隆仓库

    git clone --depth 1 --branch main https://github.com/electron-react-boilerplate/electron-react-boilerplate.git your-project-name
  2. 2

    进入项目目录

    cd your-project-name
  3. 3

    安装依赖(需要 Node.js 24+ 和 npm 10+)

    npm install
  4. 4

    以开发模式启动应用

    npm start

使用前须知

  • 需要 Node.js 24 或更新版本以及 npm 10 或更新版本。
  • 安装有时可能失败,README 指向单独的调试指南。

标签

常见问题

electron-react-boilerplate 是什么?
基于 Electron、React、TypeScript 和 Vite 的跨平台桌面应用起步模板。 Electron React Boilerplate 是一个桌面应用起步模板,使用 Electron 搭配 React 渲染进程,可构建运行于 Windows、macOS 和 Linux 的应用。项目已集成 React Router、electron-vite 以及 React Fast Refresh,主进程、preload 与渲染进程的构建和热更新开箱即用,无需从零配置。
electron-react-boilerplate 可以免费使用吗?用的什么许可证?
electron-react-boilerplate 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
electron-react-boilerplate 还在维护吗?
活跃维护中。electron-react-boilerplate 最近一次提交是在 2026年10月12日。
electron-react-boilerplate 适合用来做什么?
使用 React 与 TypeScript 启动一个新的跨平台桌面应用 学习 Electron、Vite 与 React 在实际项目结构中的配合方式 快速搭建需要开发期热更新的桌面工具原型
electron-react-boilerplate 怎么安装和运行?
克隆仓库: git clone --depth 1 --branch main https://github.com/electron-react-boilerplate/electron-react-boilerplate.git your-project-name 进入项目目录: cd your-project-name 安装依赖(需要 Node.js 24+ 和 npm 10+): npm install 以开发模式启动应用: npm start
在哪里获取 electron-react-boilerplate?
源代码和安装说明在 GitHub 上:https://github.com/electron-react-boilerplate/electron-react-boilerplate

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目