Electron Forge
GitHubDiscord
Search…
V6
Getting Started
Import Existing Project
Configuration
CLI
Built-in Templates
TypeScript
TypeScript + Webpack
Webpack
Forge Configuration
Plugins
Makers
Publishers
Guides
Electron Guides
Framework Integration
Developing with WSL
Advanced
Auto Update
Debugging
Extending Electron Forge
API Docs
Powered By GitBook
Getting Started
Electron Forge is a complete tool for creating, publishing, and installing modern Electron applications.

The Basics

To get started with Electron Forge, we first need to initialize a new project.
Yarn 1
NPM
1
yarn create electron-app my-app
Copied!
1
npx [email protected] my-app
Copied!
You should now have a directory called my-app with a ultra-minimal Electron app boilerplate inside. If you head into that directory and start up the app, you'll be all set to start developing.
Yarn
NPM
1
cd my-app
2
yarn start
Copied!
1
cd my-app
2
npm start
Copied!

Building Distributables

So you've got an amazing application there, and you want to package it all up and share it with the world. If you run the make script Electron Forge will generate you platform specific distributables for you to share with everyone. For more information on what kind of distributables you can make, check out the Makers documentation.
Yarn
NPM
1
yarn make
Copied!
1
npm run make
Copied!

Advanced Usage

Once you've got a basic app going and you can make distributables for it, you should check out the documentation on some of our more advanced features like:
Next
Import Existing Project
Last modified 2mo ago
Copy link
Contents
The Basics
Building Distributables
Advanced Usage