Because setting up
electronenvironment shouldn't be difficult.
Modern web development practices today require a lot of setup with things like
webpack to bundle your code,
babel for transpiling,
eslint for linting, and so much more that the list just goes on. Unfortunately when creating
electron applications, all of that setup just became much more difficult. The primary aim of
electron-webpack is to eliminate all preliminary setup with one simple install so you can get back to developing your application.
Why create a module and not a full boilerplate?
webpack configuration files that some may call magic when something new comes out.
Here are some of the awesome features you'll find using
- Detailed documentation
- Use of
webpackfor source code bundling
- Use of
- HMR for both
- Use of
@babel/preset-envthat is automatically configured based on your
- Ability to add custom
webpackloaders, plugins, etc.
- Add-ons to support items like TypeScript, Less, EJS, etc.
Get started fast with electron-webpack-quick-start.
# create a directory of your choice, and copy template using curl mkdir my-project && cd my-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
If you already have an existing project, or are looking for a custom approach outside of the quick start template, make sure to read over the Core Concepts, Project Structure, and Development sections of
Make sure to take advantage of the detailed documentation that
electron-webpack provides. It covers everything from how things work internally, adding custom configurations, and building your application.
Feel free to grab an issue and fix it or to share your features and improvements - PRs are always welcome!
However, in order for your contribution to be property included in the automatically generated release notes, please use our standard format for your commit messages.