Skip to content

This is a boilerplate for creating an electron app using vite, vue, and electronjs.

License

Notifications You must be signed in to change notification settings

BroJenuel-Box/vite-vue-electron

Repository files navigation

Vue 3 + Vite + Electron + TypeScript

This template should help get you started developing with Vue 3 and Typescript in Vite.

Recommended IDE Setup

VSCode + Vetur. Make sure to enable vetur.experimental.templateInterpolationService in settings!

If Using <script setup>

<script setup> is a feature that is currently in RFC stage. To get proper IDE support for the syntax, use Volar instead of Vetur (and disable Vetur).

Type Support For .vue Imports in TS

Since TypeScript cannot handle type information for .vue imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in .vue imports (for example to get props validation when using manual h(...) calls), you can use the following:

If Using Volar

Run Volar: Switch TS Plugin on/off from VSCode command palette.

If Using Vetur

  1. Install and add @vuedx/typescript-plugin-vue to the plugins section in tsconfig.json
  2. Delete src/shims-vue.d.ts as it is no longer needed to provide module info to Typescript
  3. Open src/main.ts in VSCode
  4. Open the VSCode command palette
  5. Search and run "Select TypeScript version" -> "Use workspace version"

Scripts

Run yarn electron:dev to work with electron in development mode.

yarn electron:dev

Run yarn app:build to build your electron app.

yarn app:build

Run yarn dev to open vite in browser in development mode.

yarn dev

Run yarn build to build files and can be served.

yarn build

About

This is a boilerplate for creating an electron app using vite, vue, and electronjs.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published