-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,73 +1 @@ | ||
# electron-vite-vue | ||
|
||
π₯³ Really simple `Electron` + `Vue` + `Vite` boilerplate. | ||
|
||
<!-- [![awesome-vite](https://awesome.re/mentioned-badge.svg)](https://github.com/vitejs/awesome-vite) --> | ||
<!-- [![Netlify Status](https://api.netlify.com/api/v1/badges/ae3863e3-1aec-4eb1-8f9f-1890af56929d/deploy-status)](https://app.netlify.com/sites/electron-vite/deploys) --> | ||
<!-- [![GitHub license](https://img.shields.io/github/license/caoxiemeihao/electron-vite-vue)](https://github.com/electron-vite/electron-vite-vue/blob/main/LICENSE) --> | ||
<!-- [![GitHub stars](https://img.shields.io/github/stars/caoxiemeihao/electron-vite-vue?color=fa6470)](https://github.com/electron-vite/electron-vite-vue) --> | ||
<!-- [![GitHub forks](https://img.shields.io/github/forks/caoxiemeihao/electron-vite-vue)](https://github.com/electron-vite/electron-vite-vue) --> | ||
[![GitHub Build](https://github.com/electron-vite/electron-vite-vue/actions/workflows/build.yml/badge.svg)](https://github.com/electron-vite/electron-vite-vue/actions/workflows/build.yml) | ||
[![GitHub Discord](https://img.shields.io/badge/chat-discord-blue?logo=discord)](https://discord.gg/sRqjYpEAUK) | ||
|
||
## Features | ||
|
||
π¦ Out of the box | ||
π― Based on the official [template-vue-ts](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-vue-ts), less invasive | ||
π± Extensible, really simple directory structure | ||
πͺ Support using Node.js API in Electron-Renderer | ||
π© Support C/C++ native addons | ||
π₯ It's easy to implement multiple windows | ||
|
||
## Quick Start | ||
|
||
```sh | ||
npm create electron-vite | ||
``` | ||
|
||
<!-- [![quick-start](https://asciinema.org/a/483731.svg)](https://asciinema.org/a/483731) --> | ||
|
||
![electron-vite-vue.gif](/electron-vite-vue.gif) | ||
|
||
## Debug | ||
|
||
![electron-vite-react-debug.gif](https://github.com/electron-vite/electron-vite-react/blob/main/electron-vite-react-debug.gif?raw=true) | ||
|
||
## Directory | ||
|
||
```diff | ||
+ βββ¬ electron | ||
+ β βββ¬ main | ||
+ β β βββ index.ts entry of Electron-Main | ||
+ β βββ¬ preload | ||
+ β βββ index.ts entry of Preload-Scripts | ||
βββ¬ src | ||
β βββ main.ts entry of Electron-Renderer | ||
βββ index.html | ||
βββ package.json | ||
βββ vite.config.ts | ||
``` | ||
|
||
<!-- | ||
## Be aware | ||
π¨ By default, this template integrates Node.js in the Renderer process. If you don't need it, you just remove the option below. [Because it will modify the default config of Vite](https://github.com/electron-vite/vite-plugin-electron-renderer#config-presets-opinionated). | ||
```diff | ||
# vite.config.ts | ||
export default { | ||
plugins: [ | ||
- // Use Node.js API in the Renderer-process | ||
- renderer({ | ||
- nodeIntegration: true, | ||
- }), | ||
], | ||
} | ||
``` | ||
--> | ||
|
||
## 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) | ||
# PanthorLauncher |