Skip to content

👻 A fast Simple Vite 2, Vue 3 and Electron 13.x template.

License

Notifications You must be signed in to change notification settings

toantranmei/electron-vite-starter

Repository files navigation

Electron + Vite + Typescript Project Template

👻 A fast Simple Vite 2, popular front-end frameworks and Electron 13.x template. This template should help get you started developing with Vite 2, popular front-end frameworks and Typescript in Electron.

Links

Why I should be use?

  • Dev runner, performance for develop environment
  • Production builder faster
  • Stats info for development environment
  • Secured your code on production
  • Support full Typescript =))
  • Support popular framework for renderer process.

Features

  • Automatic update new version
  • Performance electron builder
  • Pre-load window in production env

How to Use

Compatibility Note: Vite requires Node.js version >=12.0.0.

Option 1: ⚡️ It's as simple as that! So easy by command line:

With NPM:

$ npm init ev@latest

With Yarn:

$ yarn create ev

With PNPM:

$ pnpx create-ev

Then follow the prompts!

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a Vite + Vue/React/... project, run:

# npm 6.x
npm init ev@latest my-vue-app --template vue
############# OR #############
npm init ev@latest my-react-app --template react

# npm 7+, extra double-dash is needed:
npm init ev@latest my-vue-app -- --template vue
############# OR #############
npm init ev@latest my-react-app -- --template react

# yarn
yarn create ev my-vue-app --template vue
############# OR #############
yarn create ev my-react-app --template react

# pnpm
pnpx create-ev my-vue-app --template vue
############# OR #############
pnpx create-ev my-react-app --template react

Currently supported template presets include:

  • vanilla - Coming soon
  • vanilla-ts - Coming soon
  • vue - Coming soon
  • vue-ts
  • react - Coming soon
  • react-ts

Option 2: Clone the package folder repository packages/create-ev/templates.

Run Dev

🔥 Hot runner dev env

yarn dev

Build package

Built-in Windows, Mac, Linux. Please read more details in package.json scripts

<!-- Build production -->
yarn build

<!-- Build production for Windows x64 -->
yarn build:win64

Security

If you discover a security vulnerability regarding this template, please send an e-mail via trantoan.fox.97@gmail.com! All security vulnerabilities will be promptly addressed.

Show me your apps!

If you've built any applications with our template, we'd love to see them!.

License

MIT