CodyBontecou / electron-vue

Electron Vue Template

A template that comes with an Electron application bundled with VueJS 3.

Why?

This project got inspired by 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 for the development server providing HMR (Hot Reload) while developing your Electron app.
Building the Electron application is done by Electron Builder, 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:

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:

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

- 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)