Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shellyln/vue-electron-typescript-grpc-quickstart
A boilerplate of Electron app that uses Vue in TypeScript. Plus, this app implements gRPC client and spawn the child process which is a gRPC server.
https://github.com/shellyln/vue-electron-typescript-grpc-quickstart
boilerplate electron grpc javascript out-of-proc-server typescript vue vuejs
Last synced: 4 months ago
JSON representation
A boilerplate of Electron app that uses Vue in TypeScript. Plus, this app implements gRPC client and spawn the child process which is a gRPC server.
- Host: GitHub
- URL: https://github.com/shellyln/vue-electron-typescript-grpc-quickstart
- Owner: shellyln
- Created: 2019-01-28T11:59:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T16:15:49.000Z (about 2 years ago)
- Last Synced: 2024-04-24T02:26:54.727Z (10 months ago)
- Topics: boilerplate, electron, grpc, javascript, out-of-proc-server, typescript, vue, vuejs
- Language: TypeScript
- Size: 3.48 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/shellyln/vue-electron-typescript-quickstart),
and the gRPC invoking mechanism is provided by [Out-of-proc Server](https://github.com/shellyln/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](https://github.com/shellyln/out-of-proc-server/tree/master/examples/GreeterServer).
> 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](https://cli.vuejs.org/config/).
---
## **Electron Documentation (security)**
See [this](https://electronjs.org/docs/tutorial/security) guide.