This repository has been archived on 2022-10-27. You can view files and clone it, but cannot push or open issues/pull-requests.
 
 
 
 
Go to file Use this template
KaKi87 ea3eb5423e 🏗️ De-initialize 'src-vue' submodule 2022-08-07 19:12:20 +02:00
src-electron 🚚 Split 'src' directory into 'src-electron' & 'src-vue' directories 2022-03-02 14:25:10 +01:00
src-vue 🏗️ De-initialize 'src-vue' submodule 2022-08-07 19:12:20 +02:00
.gitignore Add build script 2022-02-08 20:46:40 +01:00
.gitmodules ♻️ Move 'src-vue' directory to git submodule 2022-03-02 15:10:27 +01:00
README.md 📝 As per 914aec1 2022-03-16 20:51:33 +01:00
build.mjs 🐛 Handle non-existing 'dist' & 'build' directories, replace deprecated method call 2022-08-07 18:24:54 +02:00
clone.sh 🧑‍💻 Update clone script: open shell in working directory 2022-03-16 22:42:36 +01:00
config.example.js Add spellcheck configuration 2022-02-14 10:27:57 +01:00
package.json ♻️ Merge 'main.js' & 'start.mjs' scripts 2022-08-07 18:24:54 +02:00
start.js ♻️ Merge 'main.js' & 'start.mjs' scripts 2022-08-07 18:24:54 +02:00
yarn.lock Add build script 2022-02-08 20:46:40 +01:00

README.md

template-electron17-vue3-parcel2

Opinionated Electron 17.x + Vue 3.x + Parcel 2.x template

Specs

  • process.env.NODE_ENV available from renderer script
  • Configurable
    • development server port
    • 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-electron17-vue3-parcel2/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-parcel2.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