https://github.com/codesbiome/electron-react-webpack-boilerplate
Minimal boilerplate for writing Desktop Applications using Electron, React, Webpack, Javascript in 2022
https://github.com/codesbiome/electron-react-webpack-boilerplate
electron electron-boilerplate electron-custom-titlebar electron-javascript-react electron-react electron-window hot-reload javascript-react-webpack react secure-electron-template webpack-boilerplate
Last synced: 3 months ago
JSON representation
Minimal boilerplate for writing Desktop Applications using Electron, React, Webpack, Javascript in 2022
- Host: GitHub
- URL: https://github.com/codesbiome/electron-react-webpack-boilerplate
- Owner: codesbiome
- License: mit
- Created: 2022-03-31T11:47:46.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-01T04:55:41.000Z (almost 4 years ago)
- Last Synced: 2025-01-27T22:49:12.489Z (about 1 year ago)
- Topics: electron, electron-boilerplate, electron-custom-titlebar, electron-javascript-react, electron-react, electron-window, hot-reload, javascript-react-webpack, react, secure-electron-template, webpack-boilerplate
- Language: JavaScript
- Homepage:
- Size: 414 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Electron React Webpack Boilerplate (JavaScript)
A minimal boilerplate for writing Desktop Applications using [Electron](https://www.electronjs.org/), [React](https://reactjs.org/), [Webpack](https://webpack.js.org/) & JavaScript.
This project makes use of latest packages and configurations to serve the best environment for development.
### Typescript Based Project
If you're looking for a boilerplate with Typescript support, find it here :
[ERWT - Typescript Boilerplate](https://github.com/codesbiome/electron-react-webpack-typescript-2022)
## Screenshot
## Custom Window Titlebar & Menu
This project now includes custom [Electron Window (JS)](https://github.com/guasam/electron-window-js), Titlebar, Menu Items, Window Controls & application icon etc by default. Menu items and windows controls layout or colors can be customized easily by modifying the `misc/window` modules. The `windows` platform buttons are being used by default in the Titlebar.
Menubar can be toggled by pressing `ALT` key
## Core Features
- 📐 Custom Window & Titlebar with Menus
- 🌟 Electron
- 🌀 JavaScript
- ⚛️ React
- 🛶 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 clone the boilerplate, you need to run following commands:
```bash
git clone --recurse-submodules https://github.com/codesbiome/electron-react-webpack-boilerplate
```
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 :
```bash
tools/forge/forge.config.js
```
For further information, you can visit [Electron Forge Configuration](https://www.electronforge.io/configuration)