electron-webpack-boilerplate
Minimal Electron Starter Kit built with Typescript, React, Webpack 5 and Babel 7
To create a JS library, check out js-library-boilerplate-basic.
⭐️
Features
- Electron 17
- React 17
- Webpack 5
- Babel 7
- Hot reloading (
npm start) - Jest unit testing (+ Enzyme)
📦
Getting Started
git clone https://github.com/hodgef/electron-webpack-boilerplate.git my-app
npm install
⚠️ Note: This boilerplate usesnodeIntegrationby default, which allows your renderer code to access node. Only use this boilerplate if you are running trusted code in your app. Alternatively, you can change this setting insrc/main/index.tsand adjust accordingly.
💎
Customization
Before shipping, make sure to:
- Edit
LICENSEfile - Edit
package.jsoninformation (This will be used to package your app) - (Optional) Set-up releases, code signing, notarization for your app. Additional docs on this coming soon.
🚀
Development
- Use
npm startto develop your app with Hot Reloading on changes. - Use
npm serve:distto serve a semi-production app from the build folder. - Use
npm run distto build executables for your app, according to the information in your package.json. - Use
npm run testto run unit tests for your app.
9.8k Jan 3, 2023
272 Dec 30, 2022
9 Sep 15, 2022
4 Dec 15, 2022
4 Nov 28, 2022
11 Dec 13, 2022
7 Nov 12, 2022
6 Aug 24, 2022
43 Dec 19, 2022
12 May 12, 2021