Awesome
electron-webpack-quick-start
A bare minimum project structure to get started developing with
electron-webpack
.
Thanks to the power of electron-webpack
this template comes packed with...
- Use of
webpack-dev-server
for development - HMR for both
renderer
andmain
processes - Use of
babel-preset-env
that is automatically configured based on yourelectron
version - Use of
electron-builder
to package and build a distributable electron application
Make sure to check out electron-webpack
's documentation for more details.
Getting Started
Simply clone down this repository, install dependencies, and get started on your application.
The use of the yarn package manager is strongly recommended, as opposed to using npm
.
# create a directory of your choice, and copy template using curl
mkdir new-electron-webpack-project && cd new-electron-webpack-project
curl -fsSL https://github.com/electron-userland/electron-webpack-quick-start/archive/master.tar.gz | tar -xz --strip-components 1
# or copy template using git clone
git clone https://github.com/electron-userland/electron-webpack-quick-start.git
cd electron-webpack-quick-start
rm -rf .git
# install dependencies
yarn
Development Scripts
# run application in development mode
yarn dev
# compile source code and create webpack output
yarn compile
# `yarn compile` & create build with electron-builder
yarn dist
# `yarn compile` & create unpacked build with electron-builder
yarn dist:dir