Getting Started

The Basics
To get started with Electron Forge, we first need to initialize a new project.
Yarn 1
NPM
yarn create electron-app my-app
npx [email protected] my-app
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
cd my-app
yarn start
cd my-app
npm start
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
yarn make
npm run make
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:
​Publishers​
​Debugging your app​
​Webpack support​
​Writing your own makers, publishers and plugins​

Import Existing Project

Last modified 1yr ago

Copy link

Edit on GitHub

Outline

The Basics

Building Distributables

Advanced Usage