lixuechuan
/
electron-vite-react
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore(docs): UPDATE

This commit is contained in:
草鞋没号 2021-11-10 21:19:02 +08:00
parent 0f3a9371d6
commit 2a34519e95
1 changed files with 44 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -1,18 +1,19 @@
# electron-vite-template
# vite-electron-boilerplate
![GitHub stars](https://img.shields.io/github/stars/caoxiemeihao/electron-vite-template?color=fa6470&style=flat)
![GitHub issues](https://img.shields.io/github/issues/caoxiemeihao/electron-vite-template?color=d8b22d&style=flat)
![GitHub license](https://img.shields.io/github/license/caoxiemeihao/electron-vite-template?style=flat)
![GitHub stars](https://img.shields.io/github/stars/caoxiemeihao/vite-electron-boilerplate?color=fa6470&style=flat)
![GitHub issues](https://img.shields.io/github/issues/caoxiemeihao/vite-electron-boilerplate?color=d8b22d&style=flat)
![GitHub license](https://img.shields.io/github/license/caoxiemeihao/vite-electron-boilerplate?style=flat)
[![Required Node.JS >= v14.17.0](https://img.shields.io/static/v1?label=node&message=%3E=14.17.0&logo=node.js&color=3f893e&style=flat)](https://nodejs.org/about/releases)
**English | [简体中文](README.zh-CN.md)**
## Run Setup
```bash
# clone the project
git clone git@github.com:caoxiemeihao/electron-vite-template.git
git clone git@github.com:caoxiemeihao/vite-electron-boilerplate.git
# enter the project directory
cd electron-vite-template
cd vite-electron-boilerplate
# install dependency(Recommend use yarn)
yarn
@ -23,15 +24,48 @@
## Branchs
- `main` - **[Electron + Vite + React](https://github.com/caoxiemeihao/electron-vite-template/tree/main)**
- `main` - **[Electron + Vite + React](https://github.com/caoxiemeihao/vite-electron-boilerplate/tree/main)**
- `vue-ts` - **[Electron + Vite + Vue3](https://github.com/caoxiemeihao/electron-vite-template/tree/vue-ts)**
- `vue-ts` - **[Electron + Vite + Vue3](https://github.com/caoxiemeihao/vite-electron-boilerplate/tree/vue-ts)**
## Directory
```tree
├
├── configs
├ ├── vite.main.ts Main-process config file, for -> src/main
├ ├── vite.preload.ts Preload-script config file, for -> src/preload
├ ├── vite.react-ts.ts Renderer-script config file, for -> src/react-ts
├
├── scripts
├ ├── build.mjs Build script, for -> npm run build
├ ├── electron-builder.config.mjs
├ ├── watch.mjs Develop script, for -> npm run dev
├
├── src
├ ├── main Main-process source code
├ ├── preload Preload-script source code
├ ├── react-ts Renderer-process source code
├
```
## How to work
- The Main-process, Renderer-process and Preload-script are all config in `configs/xxx.ts`
- The full-scale `Vite` compilation is supper fast
- `scripts/build.mjs` only calls the `Vite` API and uses the `configs/xxx.ts` config file to build
- The difference between `scripts/watch.mjs` and `build.mjs` is that the watch option is configured for the Main-process and Preload-script. The Renderer-process uses `require ('vite').createServer`
- The whole project tends to be configured rather than a large number of scripts, which is dazzling -- **🥳 上手简单**
## Demo
<img width="400px" src="https://raw.githubusercontent.com/caoxiemeihao/blog/main/electron-vite-template/react-win.png" />
<img width="400px" src="https://raw.githubusercontent.com/caoxiemeihao/blog/main/vite-electron-boilerplate/react-win.png" />
## Wechat group || 请我喝杯下午茶 🥳
## Wechat group | | 请我喝杯下午茶 🥳
<div style="display:flex;">
<img width="244px" src="https://raw.githubusercontent.com/caoxiemeihao/blog/main/assets/wechat/group/qrcode.jpg" />