66 lines
2.1 KiB
Markdown
66 lines
2.1 KiB
Markdown
# Vutron
|
|
Quick Start Templates for **[Vue.js 3](https://vuejs.org/)** + **[Electron.js](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.
|
|
|
|
## 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.
|
|
|
|
|
|
## Pre-configured components
|
|
|
|
- Electron 19.x.x
|
|
- Electron Builder 23.x
|
|
- Vue 3.2.x
|
|
- Vue-i18n 9.x
|
|
- Vue-router 4.x
|
|
- Vuetify 3.x (Beta)
|
|
- Babel 7.x
|
|
- Webpack 5.x
|
|
- ESLint 8.x
|
|
|
|
## Installation
|
|
To configure this project, the `NodeJS` version must be at least **17.x** or higher.
|
|
|
|
It's also experimental and relies on newer modules, with a lot of code made up of `ESM`, so it's worth checking for compatibility when using third-party modules.
|
|
|
|
After cloning the project, run the following command in the terminal:
|
|
|
|
```shell
|
|
$ npm i
|
|
```
|
|
|
|
## Run in development environment
|
|
|
|
```shell
|
|
$ npm run dev
|
|
```
|
|
|
|
## Build
|
|
|
|
```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
|
|
```
|
|
|
|
## License
|
|
Copyright © 2022 Jooy2 Released under the MIT license.
|
|
|
|
The structure and some code of this project was inspired by **[electron-vue](https://github.com/SimulatedGREG/electron-vue)**.
|