From 2a34519e956a7b4315f00098620135747ec35d55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=8D=89=E9=9E=8B=E6=B2=A1=E5=8F=B7?= <308487730@qq.com> Date: Wed, 10 Nov 2021 21:19:02 +0800 Subject: [PATCH] chore(docs): UPDATE --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 44 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8744743..c47c88a 100644 --- a/README.md +++ b/README.md @@ -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 - + -## Wechat group || 请我喝杯下午茶 🥳 +## Wechat group | | 请我喝杯下午茶 🥳