Overview

This repository contains a starter template for using vue-next with the latest version of Electron. It was inspired by the project electron-vue and follows the security guide of Electron to create a browser-only environment for the renderer process. The template also includes features such as using electron-builder for building, empowering vue-next and its eco-system, using vite for fast development, utilizing vuex 4.0 for state management, incorporating vue-router-next for routing, and implementing eslint with JavaScript Standard by default. The template also has built-in TypeScript support, uses esbuild in rollup to build main process TypeScript code, includes Github Action with Github Release out-of-the-box, and automatically bumps version in package.json and generates CHANGELOG.md if following the Conventional Commits approach. It also integrates well with VSCode, supports debugging .ts/.vue files in main/renderer process using the VSCode debugger, provides multiple window support, and includes vue-devtool support.

Features

• Electron 11
• Follows the security guide of Electron
• Uses electron-builder for building
• Empowers vue-next and its eco-system
• Uses vite for fast development
• Uses vuex 4.0 for strong type state, getters, and commit
• Uses vue-router-next for routing
• Uses eslint with JavaScript Standard by default
• Built-in TypeScript support
• Uses esbuild in rollup to build main process TypeScript code
• GitHub Action with GitHub Release out-of-the-box
• Automatic version bumping and CHANGELOG.md generation
• Integration with VSCode
• Supports debugging .ts/.vue files in main/renderer process using VSCode debugger
• Multiple windows support
• vue-devtool support

Installation

To start using the template, follow these steps:

1. Run npm init electron-vue-next <app-dirname> to initialize a new project.
2. Once you have your project, navigate to the project folder.

Summary

The starter template in this repository provides a convenient way to leverage vue-next with the latest Electron version. It includes a range of features such as secure browser-only environment, fast development with vite, strong type state management with vuex, routing with vue-router, and integration with popular developer tools like VSCode. The template also includes various setup configurations such as TypeScript support, automatic version bumping, and a GitHub Action for easy release management. Overall, it offers a comprehensive starting point for developing Electron applications with Vue.