Go to file
KaKi87 533f71b21b 🐛 Fix build script as per 5c294a1 2022-08-07 20:34:01 +02:00
src-electron 🚚 Split 'src' directory into 'src-electron' & 'src-vue' directories 2022-03-02 14:25:10 +01:00
src-vue Add HTML template 2022-08-07 20:19:29 +02:00
.gitignore 💬 As per 2982df6 & 3876d57 2022-08-07 19:45:37 +02:00
README.md Add random development server port 2022-08-07 19:58:58 +02:00
build.mjs 🐛 Fix build script as per 5c294a1 2022-08-07 20:34:01 +02:00
clone.sh 💬 As per 2982df6 & 3876d57 2022-08-07 19:45:37 +02:00
config.example.js Add HTML template 2022-08-07 20:19:29 +02:00
package.json Add HTML template 2022-08-07 20:19:29 +02:00
start.js Add HTML template 2022-08-07 20:19:29 +02:00
yarn.lock Add HTML template 2022-08-07 20:19:29 +02:00

README.md

template-electron20-vue3-vite3

Opinionated Electron 20.x + Vue 3.x + Vite 3.x template

Specs

  • process.env.NODE_ENV available from renderer script
  • Configurable
    • title & menu bar visibility
    • icon
    • 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-electron20-vue3-vite3/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-electron20-vue3-vite3.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 dist)

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

Develop everything inside src-electron & src-vue