GitHub - electron/forge: :electron: A complete tool for building and publishing Electron applications · GitHub
https://github.com/electron/forge • 341 KB fetched Open original page
GitHub - electron/forge: :electron: A complete tool for building and publishing Electron applications · GitHub
Skip to content
Navigation Menu
Sign in Appearance settings
* Platform
* AI CODE CREATION
* GitHub Copilot Write better code with AI
* GitHub Copilot app Direct agents from issue to merge
* MCP Registry Integrate external tools
* DEVELOPER WORKFLOWS
* Actions Automate any workflow
* Codespaces Instant dev environments
* Issues Plan and track work
* Code Review Manage code changes
* Code Quality Enforce quality at merge
* APPLICATION SECURITY
* GitHub Advanced Security Find and fix vulnerabilities
* Code security Secure your code as you build
* Secret protection Stop leaks before they start
* EXPLORE
* Why GitHub
* Documentation
* Blog
* Changelog
* Marketplace
View all features
* Solutions
* BY COMPANY SIZE
* Enterprises
* Small and medium teams
* Startups
* Nonprofits
* BY USE CASE
* App Modernization
* DevSecOps
* DevOps
* CI/CD
* View all use cases
* BY INDUSTRY
* Healthcare
* Financial services
* Manufacturing
* Government
* View all industries
View all solutions
* Resources
* EXPLORE BY TOPIC
* AI
* Software Development
* DevOps
* Security
* View all topics
* EXPLORE BY TYPE
* Customer stories
* Events & webinars
* Ebooks & reports
* Business insights
* GitHub Skills
* SUPPORT & SERVICES
* Documentation
* Customer support
* Community forum
* Trust center
* Partners
View all resources
* Open Source
* COMMUNITY
* GitHub Sponsors Fund open source developers
* PROGRAMS
* Security Lab
* Maintainer Community
* GitHub Stars
* Archive Program
* REPOSITORIES
* Topics
* Trending
* Collections
* Enterprise
* ENTERPRISE SOLUTIONS
* Enterprise platform AI-powered developer platform
* AVAILABLE ADD-ONS
* GitHub Advanced Security Enterprise-grade security features
* Copilot for Business Enterprise-grade AI features
* Premium Support Enterprise-grade 24/7 support
* Pricing
Search /
Sign in
Sign up Appearance settings
You signed in with another tab or window. Reload to refresh your session.
You signed out in another tab or window. Reload to refresh your session.
You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
Uh oh!
There was an error while loading. Please reload this page .
electron
/
forge
Public
*
Uh oh!
There was an error while loading. Please reload this page .
*
Notifications
You must be signed in to change notification settings
*
Fork
641
*
Star
7.1k
*
Code
*
Issues
227
*
Pull requests
38
*
Actions
*
Projects
*
Security and quality
0
*
Insights
Additional navigation options
*
Code
*
Issues
*
Pull requests
*
Actions
*
Projects
*
Security and quality
*
Insights
main
Branches Tags
Go to file
Code Open more actions menu
Latest commit
History
3,422 Commits
3,422 Commits
Folders and files
Name Name Last commit message
Last commit date
.github
.github
.husky
.husky
.vscode
.vscode
.yarn/ releases
.yarn/ releases
packages
packages
tools
tools
typings
typings
.eslintignore
.eslintignore
.eslintrc.json
.eslintrc.json
.git-blame-ignore-revs
.git-blame-ignore-revs
.gitattributes
.gitattributes
.gitignore
.gitignore
.markdownlint.json
.markdownlint.json
.markdownlintignore
.markdownlintignore
.npmrc
.npmrc
.nvmrc
.nvmrc
.prettierignore
.prettierignore
.yarnrc.yml
.yarnrc.yml
CHANGELOG.md
CHANGELOG.md
CNAME
CNAME
CONTRIBUTING.md
CONTRIBUTING.md
LICENSE
LICENSE
README.md
README.md
SUPPORT.md
SUPPORT.md
lerna.json
lerna.json
nx.json
nx.json
package.json
package.json
socket.yml
socket.yml
tsconfig.base.json
tsconfig.base.json
tsconfig.test.json
tsconfig.test.json
typedoc.base.json
typedoc.base.json
typedoc.json
typedoc.json
vitest.config.mts
vitest.config.mts
yarn.config.cjs
yarn.config.cjs
yarn.lock
yarn.lock
View all files
Repository files navigation
*
* README
* Code of conduct
* Contributing
* MIT license
More items
Electron Forge
Important
We're currently beginning feature development for the next major version of Electron Forge, which is being done in the next branch.
To try out experimental pre-releases, install the @alpha dist-tag of the @electron-forge/* packages via npm.
For more details, see issue #4082 .
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.
Website |
Goals |
Docs and Usage |
Configuration |
Support |
Contributing
Getting Started
Pre-requisites:
* Node 16.4.0 or higher
* Git
You can initialize an Electron Forge project with the create-electron-app
CLI tool.
npx create-electron-app@latest my-new-app
# then
cd my-new-app
npm start
For more information on creating a new project from a template, see our CLI documentation .
Docs and Usage
For Electron Forge documentation and usage you should check out our website:
electronforge.io
Project Goals
* 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.
Contributing
If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.
Community
Please report bugs or feature requests in our issue tracker .
You can find help for debugging your Electron Forge on the Support page , and ask questions in the official Electron Discord server , where there is a dedicated channel for Electron Forge.
About
A complete tool for building and publishing Electron applications
electronforge.io
Topics
build electron hacktoberfest javascript linux macos package typescript webpack windows
Resources
Readme
MIT license
Code of conduct
Code of conduct
Contributing
Contributing
Activity
Custom properties
Stars
7.1k stars
Watchers
77 watching
Forks
641 forks
Report repository
Releases
Sponsor this project
Packages
Used by
Contributors
Languages
Footer
(c) 2026 GitHub, Inc.
Footer navigation
*
Terms
*
Privacy
*
Security
*
Status
*
Community
*
Docs
*
Contact
*
Manage cookies
*
Do not share my personal information
You can’t perform that action at this time.
Links found on this page
- Skip to content [direct]
- Sign in [direct]
- GitHub Copilot Write better code with AI [direct]
- GitHub Copilot app Direct agents from issue to merge [direct]
- MCP Registry Integrate external tools [direct]
- Actions Automate any workflow [direct]
- Codespaces Instant dev environments [direct]
- Issues Plan and track work [direct]
- Code Review Manage code changes [direct]
- Code Quality Enforce quality at merge [direct]
- GitHub Advanced Security Find and fix vulnerabilities [direct]
- Code security Secure your code as you build [direct]
- Secret protection Stop leaks before they start [direct]
- Why GitHub [direct]
- Documentation [direct]
- Blog [direct]
- Changelog [direct]
- Marketplace [direct]
- View all features [direct]
- Enterprises [direct]
- Small and medium teams [direct]
- Startups [direct]
- Nonprofits [direct]
- App Modernization [direct]
- DevSecOps [direct]
- DevOps [direct]
- CI/CD [direct]
- View all use cases [direct]
- Healthcare [direct]
- Financial services [direct]
- Manufacturing [direct]
- Government [direct]
- View all industries [direct]
- View all solutions [direct]
- AI [direct]
- Software Development [direct]
- DevOps [direct]
- Security [direct]
- View all topics [direct]
- Customer stories [direct]
- Events & webinars [direct]
- Ebooks & reports [direct]
- Business insights [direct]
- GitHub Skills [direct]
- Customer support [direct]
- Community forum [direct]
- Trust center [direct]
- Partners [direct]
- View all resources [direct]
- GitHub Sponsors Fund open source developers [direct]
- Security Lab [direct]
- Maintainer Community [direct]
- GitHub Stars [direct]
- Archive Program [direct]
- Topics [direct]
- Trending [direct]
- Collections [direct]
- Copilot for Business Enterprise-grade AI features [direct]
- Premium Support Enterprise-grade 24/7 support [direct]
- Pricing [direct]
- Sign up [direct]
- electron [direct]
- Notifications [direct]
- Issues
227 [direct]
- Pull requests
38 [direct]
- Actions [direct]
- Projects [direct]
- Security and quality
0 [direct]
- Insights [direct]
- Branches [direct]
- Tags [direct]
- 3,422 Commits [direct]
- .github [direct]
- .husky [direct]
- .vscode [direct]
- .yarn/ releases [direct]
- packages [direct]
- tools [direct]
- typings [direct]
- .eslintignore [direct]
|
|