https://github.com/codybontecou/electron-vue
https://github.com/codybontecou/electron-vue
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codybontecou/electron-vue
- Owner: CodyBontecou
- License: mit
- Created: 2021-12-07T22:15:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-01T23:43:12.000Z (almost 3 years ago)
- Last Synced: 2024-12-29T10:33:50.159Z (5 months ago)
- Language: JavaScript
- Size: 588 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Electron Vue Template
A template that comes with an Electron application bundled with VueJS 3.
## Why?
This project got inspired by [electron-vue](https://github.com/SimulatedGREG/electron-vue)
electron-vue-template uses updated Electron/Vue versions and build tools! 👍 The idea of this template is to keep it a really simple Electron application without unnecessary dependency overhead.
## About
This template uses [ViteJS](https://vitejs.dev) for the development server providing HMR (Hot Reload) while developing your Electron app.\
Building the Electron application is done by [Electron Builder](https://www.electron.build/), making your application cross-platform and easily distributable.
This template doesn't come with any unnecessary dependencies and is unopinionated, so you can start developing your Electron / Vue applications however you want.
## Get Started
To start developing your Electron application execute the following commands:
```bash
git clone https://github.com/Deluze/electron-vue-template
cd electron-vue-template
npm install
npm run dev
```
That's all!
## Commands
This template only comes with 2 necessary commands:
```bash
npm run dev # start Electron application and ViteJS devserver for development
npm run build # builds the renderer with ViteJS and compiles it with Electron Builder
```
## Project Structure
```bash
- root
- config/
- vite.js # ViteJS configuration
- electron-builder.js # Electron Builder configuration
- scripts/ # all the scripts used to build or serve your application, change as you like.
- src/
- main/ # Main thread (Electron application source)
- renderer/ # Renderer thread (VueJS application source)
```