Electron Forge

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 | Changelog

---

Getting Started

Pre-requisites:

• Node 16.4.0 or higher
• Git

If you have a more recent version of npm or yarn, you can use npx, or yarn create.

npx create-electron-app my-new-app
# or
yarn create electron-app 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

1. Starting with Electron should be as simple as a single command.
2. 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.
3. 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.

To install Yarn using the terminal, follow these steps based on your operating system:

1. Using npm (Node Package Manager) If you already have Node.js and npm installed, you can use npm to install Yarn:

npm install --global yarn

2. Using Homebrew (macOS) If you are using a macOS system and have Homebrew installed, you can use the following command:

brew install yarn

Note: You don't need to have npm if you're using Homebrew.

3. Using apt (Ubuntu and Debian-based Linux) First, configure the Yarn repository and import the GPG key:

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -

echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list Then, update the package list and install Yarn:

sudo apt update && sudo apt install yarn

Note: If you don't want to install Node.js through apt, you can use the --no-install-recommends flag.

4. Using Chocolatey (Windows) If you are on Windows and have Chocolatey installed, use this command:

choco install yarn

5. Verifying the Installation After installation, you can verify that Yarn is installed and check the version by running:

yarn --version

Let me know if you need assistance with any specific part of the installation process!