https://github.com/codesbiome/electron-vue-typescript-webpack-2022
Minimal boilerplate for writing Desktop Applications using Electron, Vue, Typescript & Webpack in 2022
https://github.com/codesbiome/electron-vue-typescript-webpack-2022
2021 boilerplate electron electron-boilerplate electron-forge electron-vue electron-webpack hmr minimal secure-electron-template typescript vue webpack
Last synced: about 2 months ago
JSON representation
Minimal boilerplate for writing Desktop Applications using Electron, Vue, Typescript & Webpack in 2022
- Host: GitHub
- URL: https://github.com/codesbiome/electron-vue-typescript-webpack-2022
- Owner: codesbiome
- License: mit
- Created: 2021-09-24T01:09:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-24T01:49:45.000Z (over 4 years ago)
- Last Synced: 2025-03-22T18:31:00.849Z (about 1 year ago)
- Topics: 2021, boilerplate, electron, electron-boilerplate, electron-forge, electron-vue, electron-webpack, hmr, minimal, secure-electron-template, typescript, vue, webpack
- Language: JavaScript
- Homepage:
- Size: 226 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Electron Vue Typescript Webpack - Boilerplate 2021
EVTW is a minimal boilerplate for writing Desktop Applications using [Electron](https://www.electronjs.org/), [React](https://reactjs.org/), [Webpack](https://webpack.js.org/) & [TypeScript](https://www.typescriptlang.org/).
This project makes use of latest packages and configurations to serve the best environment for development.
## Screenshot
## Core Features
- 🌟 Electron
- 🌀 TypeScript
- ✌🏻 Vue
- 🛶 LESS Loader
- 🎨 CSS Loader
- 📸 Image Loader
- 🆎 Font Loader
- 🧹 ESLint
- 📦 Electron Forge
- 🔱 Webpack & Configuration
- 🧩 Aliases for project paths
- 🔥 Hot Module Replacement (Live Reload)
- 🎁 Package Bundling (Distribution / Release)
## Installation
#### To install the EVTW boilerplate you need to run following commands
Clone the repository :
```bash
git clone https://github.com/codesbiome/electron-vue-typescript-webpack-2021 evtw
cd evtw
```
Install dependencies using [Yarn](https://www.npmjs.com/package/yarn) or [NPM](https://www.npmjs.com/) :
```bash
yarn install
```
## Start : Development
To develop and run your application, you need to run following command.
Start electron application for development :
```bash
yarn start
```
## Lint : Development
To lint application source code using ESLint via this command :
```bash
yarn lint
```
## Package : Production
Customize and package your Electron app with OS-specific bundles (.app, .exe etc)
```bash
yarn package
```
## Make : Production
Making is a way of taking your packaged application and making platform specific distributables like DMG, EXE, or Flatpak files (amongst others).
```bash
yarn make
```
## Publish : Production
Publishing is a way of taking the artifacts generated by the `make` command and sending them to a service somewhere for you to distribute or use as updates. (This could be your update server or an S3 bucket)
```bash
yarn publish
```
## Packager & Makers Configuration
This provides an easy way of configuring your packaged application and making platform specific distributables like DMG, EXE, or Flatpak files.
This configurations file is available in :
```
tools/forge/forge.config.js
```
For further information, you can visit [Electron Forge Configuration](https://www.electronforge.io/configuration)