132 lines
4.3 KiB
Markdown
132 lines
4.3 KiB
Markdown
<div align="center">
|
|
|
|
|
|
|
|
Quick Start Templates for **[Vite](https://vitejs.dev)** + **[Vue 3](https://vuejs.org)** + **[Electron](https://www.electronjs.org)**
|
|
|
|
[](https://github.com/jooy2/vutron/blob/master/LICENSE)      [](https://github.com/jooy2)
|
|
|
|
**Vutron** is a preconfigured template for developing `Electron` cross-platform desktop apps. It uses `Vue 3` and allows you to build a fast development environment with little effort.
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## ⚠️ NOTE: Vutron now uses the Vite compiler!!!
|
|
|
|
By using the Vite compiler, we achieved our goals of reducing project and bundle size, and improving development environment and build speed.
|
|
|
|
The old Vutron using the Webpack5 compiler has been split into the repositories below and will end support soon.
|
|
|
|
https://github.com/jooy2/vutron-webpack
|
|
|
|
---
|
|
|
|
## Advantages of use
|
|
|
|
- ✅ You can build immediately without any presets, so you can develop quickly.
|
|
- ✅ It is being maintained quickly to be compatible with the latest `Vue` and `Electron`, as well as many modules.
|
|
- ✅ There is no need to worry about layout and data management by using various additional templates.
|
|
|
|
## Features
|
|
|
|
- ⚡️ Rapid development through hot-reload
|
|
- ⚡️ Cross-platform development and build support
|
|
- ⚡️ Multilingual support
|
|
- ⚡️ Support for themes (dark & light)
|
|
- ⚡️ Basic layout manager
|
|
- ⚡️ Global state management through the Pinia store
|
|
- ⚡️ TypeScript support
|
|
|
|
## Pre-configured components
|
|
|
|
- [Vite 3.x.x](https://vitejs.dev)
|
|
- [Electron 21.x.x](https://www.electronjs.org)
|
|
- [Electron Builder 23.x](https://www.electron.build)
|
|
- [TypeScript 4.x](https://www.typescriptlang.org)
|
|
- [Vue 3.2.x](https://vuejs.org)
|
|
- [Vue-i18n 9.x](https://kazupon.github.io/vue-i18n)
|
|
- [Vue-router 4.x](https://router.vuejs.org)
|
|
- [Vuetify 3.x (Beta)](https://next.vuetifyjs.com)
|
|
- [Pinia 2.x](https://pinia.vuejs.org)
|
|
- [ESLint 8.x](https://eslint.org)
|
|
- [Prettier 2.x.x](https://prettier.io)
|
|
|
|
## Installation
|
|
|
|
You can easily clone a repository with just the npm command. (Recommend)
|
|
|
|
```shell
|
|
$ npm init vutron
|
|
```
|
|
|
|
OR, Click **[Use this template](https://github.com/jooy2/vutron/generate)** to instantly create your own project.
|
|
|
|
OR, Clone this repo using below command.
|
|
|
|
```shell
|
|
$ git clone https://github.com/jooy2/vutron <PROJECT_NAME>
|
|
```
|
|
|
|
After cloning the project, run the following command in the terminal:
|
|
|
|
```shell
|
|
# via npm
|
|
$ npm i
|
|
|
|
# via yarn
|
|
$ yarn install
|
|
|
|
# via pnpm
|
|
$ pnpm i
|
|
```
|
|
|
|
## Run in development environment
|
|
|
|
```shell
|
|
$ npm run dev
|
|
```
|
|
|
|
## Build
|
|
|
|
Once the module installation is complete, you can simply build the platform package with the command below.
|
|
|
|
```shell
|
|
# For Windows (.exe, .appx)
|
|
$ npm run build:win
|
|
|
|
# For macOS (.dmg)
|
|
$ npm run build:mac
|
|
|
|
# For Linux (.rpm, .deb, .snap)
|
|
$ npm run build:linux
|
|
```
|
|
|
|
The built packages can be found in `dist/release/{version}` location.
|
|
|
|
### What do I need to do for a multi-platform build?
|
|
|
|
**macOS** is recommended if you want to build multiple platforms simultaneously on one platform. Because it can be configured with just a few very simple settings.
|
|
|
|
You can perform multi-platform builds at once with the following command. Alternatively, you can just do it for the OS you want via the individual build commands above.
|
|
|
|
```shell
|
|
$ npm run build
|
|
```
|
|
|
|
`Multipass` configuration may be required for Linux builds. Learn more about `Multipass` through the following link: https://multipass.run
|
|
|
|
## Looking for Electron templates made with React?
|
|
|
|
Also check out the `Retron` project, which consists of Vite + React + Material-UI + Electron.
|
|
|
|
https://github.com/jooy2/retron
|
|
|
|
## Contribute
|
|
|
|
You can report issues on [Github Issue](https://github.com/jooy2/vutron/issues). You can also request a pull to fix bugs and add frequently used features.
|
|
|
|
## License
|
|
|
|
Copyright © 2022 Jooy2 Released under the MIT license.
|