vue-electron-typescript-grpc-quickstart

A boilerplate of Electron app that uses Vue in TypeScript.
This is based on the output of Vue CLI 3 and is not ejecting from the CLI.

Plus, this app implements gRPC client and spawn the child process which is a gRPC server.

This boilerplate is based on vue-electron-typescript-quickstart, and the gRPC invoking mechanism is provided by Out-of-proc Server.

Usage

git clone https://github.com/shellyln/vue-electron-typescript-grpc-quickstart.git
cd vue-electron-typescript-grpc-quickstart

vi package.json
# and edit package name, author, ...

rm package-lock.json
npm install

rm -rf .git/
git init
git add .
git commit -m "initial commit."

npm run build
npm run build:mainproc
npm start

Note: gRPC server process executable is needed. You can download the source from here.
The path of the executable can be set in config/app-config.json.

Project setup

npm install

~~Compiles and hot-reloads for development~~

npm run serve

Compiles and minifies for production (electron renderer process)

npm run build

Compiles and minifies for production (electron main process)

npm run build:mainproc

Clean project

npm run clean

Start electron app for debug

npm run start

Build electron distribution executable files (unpacked)

npm run pack

Build electron distribution executable files (packing to the installer)

npm run dist

Run your tests

npm run test

Lints and fixes files

npm run lint

Run your unit tests (renderer process)

npm run test:unit

Customize configuration

See Configuration Reference.

Electron Documentation (security)

See this guide.