Template for building desktop applications using Electronjs and Vue.js
This template takes advantage of webpack-4
with vue-loader
, electron-builder
, and some of the most used plugins like vue-router
, vuex
and so much more to provide an easy to use development (with vscode debugging) and build enviroment.
- Bulma-Pro, a theme suitable for desktop application based on Bulma
- vue-router
- vuex
- vue-electron
- material-design-icons installed
- Some built-in animaitons animations.scss
- SCSS/SASS support with vue-loader (removes unused css/styles during build)
- Typescript support configured
- Worker scripts (for performing CPU-intensive JavaScript operations), to use with nodejs
child_process
module. Sample Worker File - Easily package your electron app using electron-builder
- Installed vue-devtools and devtron tools for development
DEV
,DEBUG
&BUILD
NPM scripts using webpack-4 and vue-loader with Hot Module Replacement enabled- Babel configured
- ESLint configured
- VSCODE debug config for renderer process debugging
- Process restarting when working in main process
Clone this repository, install dependencies and run using either dev
, debug
or build
command.
# Clone this repository
git clone https://github.com/mubaidr/vue-electron
# change directory to cloned path
cd vue-electron
# Install dependencies
npm install
# Run in `debug` mode, to debug app using VSCODE
npm run debug
# Run in `dev` mode
npm run dev
# Build installer for this app
npm run build
src/main
contains electron main script.
src/renderer
contains vue-js application.
src/workerSample.ts
a sample worker script.
All credits to authors of packages and tools used in the project.
* This template is inspired by electron-vue
Thanks goes to these wonderful people (emoji key):
Jibbie R. Eguna 🎨 |
---|
This project follows the all-contributors specification. Contributions of any kind welcome!