Overwrite

demo docs

Vite+Electron = 🔥

This template uses Vite as bundler and Electron builder as compiler.

This is a minimalist template designed for a simple and flexible start of your project.

Important

I work on this template in my free time, and work on it on my own.

If you have ideas, questions or suggestions - Welcome to discussions. 😊

Features

Electron
- Template use the latest electron version with all the latest security patches.
- The architecture of the application is built according to the security guids and best practices.
- The latest version of the electron-builder is used to compile the application.
Vite
- Vite is used to package all source codes. This is an extremely fast packer that has a bunch of great features. You can learn more about how it is arranged in this video.
- Vite supports reading .env files. My template has a separate command to generate .d.ts file with type definition your environment variables.
TypeScript
- The Latest TypeScript is used for all source code.
- Vite supports TypeScript out of the box. However, it does not support type checking.
- Type checking is performed in both .ts and .vue files thanks to @vuedx/typecheck.
- Code formatting rules follow the latest TypeScript recommendations and best practices thanks to @typescript-eslint/eslint-plugin.
Vue 3
- By default, web pages are built using the latest version of the Vue. However, there are no problems with using any other frameworks or technologies.
- ~~The latest version of the Vue router is also used~~. See #6.
- Code formatting rules follow the latest Vue recommendations and best practices thanks to eslint-plugin-vue.
Continuous Integration
- The configured workflow for check the types for each push and PR.
- The configured workflow for check the code style for each push and PR.
Continuous delivery
- Each time you push changes to the main branch, a workflow starts, which creates a new github release.
  - The version number is automatically set based on the current date in the format "yy.mm.dd".
  - Notes are automatically generated and added to the new release.
- Automatic update from GitHub releases is supported.

Status

✅ Building main and renderer endpoints in production mode -- works great.
✅ Development mode with hot reload for renderer endpoint -- works great.
⚠ Development mode for main and preload endpoints -- work fine, but it is possible to reboot the backend faster (vite#972)
✅ Compile the app with electron builder in CD -- work.
✅ Auto update -- work.
✅ Typechecking in .ts and .vue files -- work thanks @vuedx/typecheck (🚨 Pre Alpha)
⚠ Linting -- work fine, but need review the configuration files and refactor its. It may also intersect somewhat with Typechecking.
⏳ Code signing -- planned.
⏳ Add Vue dev tools -- planned.
⏳ Refactor and simplify the set of npm scripts -- planned.
⏳ Refactor and simplify eslint configs -- planned.

How it works

The template required a minimum dependencies. Only Vite is used for building, nothing more.

All additional dependencies for linter or typechecking well be install, if necessary in the CI workflow.

Modes and Environment Variables

All environment variables set as part of the import.meta, so you can access them as follows: import.meta.env.

You can also build type definitions of your variables by running /bin/buildEnvTypes.js. This command will create /types/env.d.ts file with describing all environment variables for all modes.

The mode option is used to specify the value of import.meta.env.MODE and the corresponding environment variables files that needs to be loaded.

By default, there are two modes:

production is used by build:* scripts
development is used by watch:build:* scripts

When running build:* or watch:build:*, environment variables are loaded from the following files in your project root:

.env                # loaded in all cases
.env.local          # loaded in all cases, ignored by git
.env.[mode]         # only loaded in specified env mode
.env.[mode].local   # only loaded in specified env mode, ignored by git

Note: only variables prefixed with VITE_ are exposed to your code. e.g. VITE_SOME_KEY=123 will be exposed as import.meta.env.VITE_SOME_KEY, but SOME_KEY=123 will not. This is because the .env files may be used by some users for server-side or build scripts and may contain sensitive information that should not be exposed in code shipped to browsers.

Project Structure

/src Contains all source code.
- /src/main Contain entrypoint for Electron main script.
- /src/renderer Contain entrypoint for Electron web page. All files in this directory work as a regular Vue application.
- /src/preload Contain entrypoint for custom script. It uses as preload script in BrowserWindow.webPreferences.preload. See Checklist: Security Recommendations.
- /src/* It is assumed any entry points will be added here, for custom scripts, web workers, webassembly compilations, etc.
/dist
- /dist/source Contains all bundled code.
  - /dist/source/main Bundled main entrypoint.
  - /dist/source/renderer Bundled renderer entrypoint.
  - /dist/source/preload Bundled preload entrypoint.
  - /dist/source/* Bundled any custom files.
- /dist/app Contain packages and ready-to-distribute electron apps for any platform. Files in this directory created using electron-builder.
/config Contains various configuration files for Vite, TypeScript, electron builder, etc.
/bin It is believed any scripts for build the application will be located here.
/types Contains all declaration files to be applied globally to the entire project

Development Setup

This project requires at least 14 versions or later.

Fork this repository
Run npm install to install all dependencies
Build all entry points for production -- npm run build
Compile Electron app -- npm run electron-builder
Build single entry point for production -- npm run build:<entrypoint>
Run development watching build -- npm run watch:build:<entrypoint>
Run electron in development mode -- npm run electron

cawa-93/generate-changelog-action-issue