diff --git a/README.md b/README.md index 09538eb..363a05b 100644 --- a/README.md +++ b/README.md @@ -11,41 +11,49 @@ 🥳 Real simple `Electron` + `Vue` + `Vite` boilerplate. -## Quick Start - -[![quick-start](https://asciinema.org/a/483731.svg)](https://asciinema.org/a/483731) - ## Overview -This is a `Vite`-integrated `Electron` template built with simplification in mind. +📦 Out of the box +💪 Support C/C++ addons +🔩 Support Use Electron、Node.js API in Renderer-process +🌱 Simple directory structure,real flexible +🖥 It's easy to implement multiple windows -The repo contains only the most basic files, dependencies and functionalities to ensure flexibility for various scenarios. +## Quick Start -You need a basic understanding of `Electron` and `Vite` to get started. But that's not mandatory - you can learn almost all the details by reading through the source code. Trust me, this repo is not that complex. 😋 +```sh +npm create electron-vite +``` + + + +![electron-vite-vue.gif](https://github.com/electron-vite/electron-vite-vue/blob/main/packages/renderer/public/electron-vite-vue.gif?raw=true) + +## Debug + +![electron-vite-react-debug.gif](https://github.com/electron-vite/electron-vite-react/blob/main/packages/renderer/public/electron-vite-react-debug.gif?raw=true) ## Directory A `dist` folder will be generated everytime when `dev` or `build` command is executed. File structure of `dist` is identical to the `packages` directory to avoid any potential path calculation errors. ```tree -├ ├── dist Will be generated following the structure of "packages" directory -├ ├── main -├ ├── preload -├ ├── renderer -├ +| ├── main +| ├── preload +| └── renderer +| ├── scripts -├ ├── build.mjs Build script -> npm run build -├ ├── watch.mjs Develop script -> npm run dev -├ +| ├── build.mjs Build script -> npm run build +| └── watch.mjs Develop script -> npm run dev +| ├── packages -├ ├── main Main-process source code -├ ├── vite.config.ts -├ ├── preload Preload-script source code -├ ├── vite.config.ts -├ ├── renderer Renderer-process source code -├ ├── vite.config.ts -├ +| ├── main Main-process source code +| | └── vite.config.ts +| ├── preload Preload-script source code +| | └── vite.config.ts +| └── renderer Renderer-process source code +| └── vite.config.ts ``` ## List the modules you may use as far as possible @@ -60,19 +68,7 @@ Used in Renderer-process 👉 [electron-vite-boilerplate/tree/nodeIntegration](h - [node-fetch](https://www.npmjs.com/package/node-fetch) - [file-type](https://www.npmjs.com/package/file-type) -**Native Addons** +**Native Addons(C/C++)** - [sqlite3](https://www.npmjs.com/package/sqlite3) - [serialport](https://www.npmjs.com/package/serialport) - -## Main window - - -## 请我喝杯下午茶 🥳 - -