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 create electron-app my-app
npx create-electron-app 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.

cd my-app
yarn start
# or with npm: 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 make
# or with npm: 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: