Secure template (if its not secure enough, lets make it) for electron applications with some nice DX. Under the hood is used webpack with esbuild — super fast, hot reload, frontend framework agnostic and electron-builder for compilation.
-
Found a problem, wanna refactor or fix for security issue?
Issues
andpull requests
are welcome. -
If you have questions or suggestions - feel free to discuss it
- Click the Use this template button. (or clone if that makes you more comfy ☕)
NOTE: we recommend usage of yarn over
npm
yarn install
- install deps needed for development and buildyarn dev
- start a development environmentyarn package
- build and package application so we can release ityarn test
- test your codeyarn lint
- check code quality
NOTE: there is
yarn build
but its used for debugging purposes (packaging takes long time)
This template was created for public to use and grasp anything valuable from it.
Please still feel free to invest in this template, but idea is that this is just a bare minimum or like a bare template that "every" project needs (at least in my case)
Unfortunately i cannot guarantee that this template is going to be maintained in the future.
- ⚠ Some files require refactoring.
- ⚠ Things still in TODO (not sure if that should be done for everyone)
- Needs more examples or at least popular framework integrations (maybe as branches?)
- ⚠ We have webpack, we should be able to use only esbuild and its API
Pull requests are welcome.
Structure is really simple, everything thats needed is in src directory
-
src/main
Electron's main script. -
src/preload
Electron's way to make bridge between renderer and main/node processes Please check Security Recommendations -
src/renderer
Electron's webview.