https://github.com/electron-userland/electron-webpack-quick-start

A bare minimum project structure to get started developing with electron-webpack.
https://github.com/electron-userland/electron-webpack-quick-start

Last synced: 3 days ago
JSON representation

A bare minimum project structure to get started developing with electron-webpack.

• Host: GitHub
• URL: https://github.com/electron-userland/electron-webpack-quick-start
• Owner: electron-userland
• Created: 2017-08-28T05:26:57.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:50:44.000Z (almost 2 years ago)
• Last Synced: 2024-08-02T02:12:54.097Z (3 months ago)
• Language: JavaScript
• Homepage: https://webpack.electron.build/
• Size: 845 KB
• Stars: 729
• Watchers: 18
• Forks: 257
• Open Issues: 57
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# electron-webpack-quick-start

> A bare minimum project structure to get started developing with [`electron-webpack`](https://github.com/electron-userland/electron-webpack).

Thanks to the power of `electron-webpack` this template comes packed with...

* Use of [`webpack-dev-server`](https://github.com/webpack/webpack-dev-server) for development

* HMR for both `renderer` and `main` processes

* Use of [`babel-preset-env`](https://github.com/babel/babel-preset-env) that is automatically configured based on your `electron` version

* Use of [`electron-builder`](https://github.com/electron-userland/electron-builder) to package and build a distributable electron application

Make sure to check out [`electron-webpack`'s documentation](https://webpack.electron.build/) for more details.

## Getting Started

Simply clone down this repository, install dependencies, and get started on your application.

The use of the [yarn](https://yarnpkg.com/) package manager is **strongly** recommended, as opposed to using `npm`.

```bash

# 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

```bash

# 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

```