Overview

Stand With UkraineVite Electron Builder Boilerplate is a template for creating secure electron applications. It is designed following the latest safety requirements, recommendations, and best practices. The template uses Vite as a bundler and electron-builder for packaging the application.

Features

• Electron version: The template uses the latest version of Electron with all the latest security patches. The application architecture is built according to security guides and best practices.
• Vite version: Vite is used as a bundler for all the source codes. It is known for its extremely fast performance and offers a wide range of amazing features. It supports reading .env files and provides automatic hot-reloads for the Main and Renderer processes. Vite also supports TypeScript, TSX/JSX, CSS/JSON Importing, CSS Modules, Web Assembly, and more.
• TypeScript version (optional): The template uses the latest version of TypeScript for all the source code. Vite provides built-in support for TypeScript, but it does not support type checking. The code formatting rules follow the latest TypeScript recommendations and best practices.
• Vue version (optional): By default, the web pages in the template are built using Vue, but it can be easily changed. The code formatting rules follow the latest Vue recommendations and best practices.
• Continuous Integration: The template includes a configured workflow that checks the types and code style for each push and pull request.
• Automatic tests: The template includes Vitest, a blazing fast test framework powered by Vite. Unit tests are placed within each package and run separately. End-to-end tests are placed in the root tests directory and use playwright.
• Publishing: The template includes a release workflow that starts each time changes are pushed to the main branch. It creates a new draft release and replaces artifacts for each commit. This ensures that there is always a draft with the latest artifacts, and the release can be published once it is ready.
• Code signing: The template supports code signing for added security.

Installation

To get started with the template, follow these steps:

1. Click the “Use this template” button to create a new repository based on the template or clone this repository.
2. If you want to use a different package manager, you may need to edit the “.github/workflows” file, which defaults to npm.
3. If you find the template useful, consider giving it a GitHub star or showing support.

Note: This template uses the npm v7 feature of automatically installing peer dependencies. If you are using a different package manager, you may need to install some peer dependencies manually.

Summary

Stand With UkraineVite Electron Builder Boilerplate is a secure template for creating electron applications. It utilizes Vite as a bundler and offers features such as automatic hot-reloading, TypeScript support, and Vue integration. The template includes continuous integration and automatic testing, making it easy to maintain and deploy applications. With the release workflow and code signing support, it provides a streamlined process for publishing secure applications.