template-electron17-vue3/README.md

1.3 KiB

template-electron17-vue3

Opinionated Electron 17.x + Vue 3.x template

Specs

  • Configurable
    • title & menu bar visibility
    • CORS
    • spellcheck
  • Developer-friendly
  • Cross-platform
    • start & build scripts
    • builds (AppImage for Linux, NSIS for Windows, DMG for Mac)
  • Fully dark app & DevTools
  • Shows window once ready

Installation

Automated

curl -s https://git.kaki87.net/KaKi87/template-electron17-vue3/raw/branch/master/clone.sh | bash -s hello-world

Manual

Clone existing repo & create new repo :

git clone --recurse-submodules https://git.kaki87.net/KaKi87/template-electron17-vue3.git hello-world
cd hello-world
rm -r .git
git init
git add .
git commit -m ":tada: Initial commit"

Install dependencies : yarn install

Create configuration file : cp config.example.js config.js

Usage

Start development server using yarn start (outputs temporary files in .parcel-cache & dist)

Create production build using yarn build (outputs production file in build)

Develop everything inside src-electron & src-vue