A complete tool for building modern Electron applications.
Electron Forge unifies the existing (and well maintained) build tools for Electron development into a simple, easy to use package so that anyone can jump right in to Electron development.
🚨 🚧 WARNING 🚧 🚨
master branch is a rewrite of Electron Forge that will eventually be the 6.x series. If you
are looking for the 5.x series (the version currently published to NPM), please view the 5.x branch.
Note: Electron Forge requires Node 6 or above, plus git installed.
npm install -g @electron-forge/cli@beta electron-forge init my-new-app cd my-new-app npm start
npx create-electron-app my-new-app # or yarn create electron-app my-new-app # then cd my-new-app npm start
- Starting with Electron should be as simple as a single command.
- Developers shouldn't have to worry about setting up build tooling, native module rebuilding, etc. Everything should "just work" for them out of the box.
- Everything from creating the project to packaging the project for release should be handled by one core dependency in a standard way while still offering users maximum choice and freedom.
With these goals in mind, under the hood this project uses, among others:
electron-rebuild: Automatically recompiles native Node.js modules against the correct Electron version.
- Electron Packager: Customizes and bundles your Electron app to get it ready for distribution.
Docs and Usage
For Electron Forge documentation and usage you should check out our website: electronforge.io
How do I use this with
random build tool?
Getting the code base running locally requires the
bolt command installed globally. An example is given below.
npm i -g bolt git clone https://github.com/electron-userland/electron-forge cd electron-forge # Installs all dependencies, don't run "yarn" or "npm install" yourself bolt # Builds all the TS code bolt build
NOTE: Please ensure that all changes are committed using semantic commits, we expose a helper
to make this easier.
For more information you should check out our Contributing guide.
|Samuel Attard||Mark Lee|