https://github.com/electron-vite/electron-vite-react

:electron: Electron + Vite + React + Sass boilerplate.
https://github.com/electron-vite/electron-vite-react

electron nodejs react sass typescript vite

Last synced: 5 days ago
JSON representation

:electron: Electron + Vite + React + Sass boilerplate.

• Host: GitHub
• URL: https://github.com/electron-vite/electron-vite-react
• Owner: electron-vite
• License: mit
• Created: 2021-11-02T05:02:59.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-17T11:35:25.000Z (2 months ago)
• Last Synced: 2025-01-09T12:11:54.218Z (12 days ago)
• Topics: electron, nodejs, react, sass, typescript, vite
• Language: TypeScript
• Homepage: https://electron-vite.github.io
• Size: 14.3 MB
• Stars: 1,998
• Watchers: 15
• Forks: 248
• Open Issues: 43
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• fucking-awesome-vite - electron-vite-react - Electron + Vite + React template. (Get Started / Templates)
• awesome-vite - electron-vite-react - Electron + Vite + React template. (Get Started / Templates)

README

        
# electron-vite-react

[![awesome-vite](https://awesome.re/mentioned-badge.svg)](https://github.com/vitejs/awesome-vite)

![GitHub stars](https://img.shields.io/github/stars/caoxiemeihao/vite-react-electron?color=fa6470)

![GitHub issues](https://img.shields.io/github/issues/caoxiemeihao/vite-react-electron?color=d8b22d)

![GitHub license](https://img.shields.io/github/license/caoxiemeihao/vite-react-electron)

[![Required Node.JS >= 14.18.0 || >=16.0.0](https://img.shields.io/static/v1?label=node&message=14.18.0%20||%20%3E=16.0.0&logo=node.js&color=3f893e)](https://nodejs.org/about/releases)

English | [简体中文](README.zh-CN.md)

## 👀 Overview

📦 Ready out of the box  

🎯 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  

🌱 Easily extendable and customizable  

💪 Supports Node.js API in the renderer process  

🔩 Supports C/C++ native addons  

🐞 Debugger configuration included  

🖥 Easy to implement multiple windows  

## 🛫 Quick Setup

```sh

# clone the project

git clone https://github.com/electron-vite/electron-vite-react.git

# enter the project directory

cd electron-vite-react

# install dependency

npm install

# develop

npm run dev

```

## 🐞 Debug

![electron-vite-react-debug.gif](/electron-vite-react-debug.gif)

## 📂 Directory structure

Familiar React application structure, just with `electron` folder on the top :wink:  

*Files in this folder will be separated from your React application and built into `dist-electron`*  

```tree

├── electron                                 Electron-related code

│   ├── main                                 Main-process source code

│   └── preload                              Preload-scripts source code

│

├── release                                  Generated after production build, contains executables

│   └── {version}

│       ├── {os}-{os_arch}                   Contains unpacked application executable

│       └── {app_name}_{version}.{ext}       Installer for the application

│

├── public                                   Static assets

└── src                                      Renderer source code, your React application

```

## 🔧 Additional features

1. electron-updater 👉 [see docs](src/components/update/README.md)

1. playwright

## ❔ FAQ

- [C/C++ addons, Node.js modules - Pre-Bundling](https://github.com/electron-vite/vite-plugin-electron-renderer#dependency-pre-bundling)

- [dependencies vs devDependencies](https://github.com/electron-vite/vite-plugin-electron-renderer#dependencies-vs-devdependencies)