Electron Forge
  • Getting Started
  • Importing an Existing Project
  • CLI
  • Core Concepts
    • Why Electron Forge?
    • Build Lifecycle
  • Configuration
    • Configuration Overview
    • TypeScript Setup
    • Plugins
      • Webpack Plugin
      • Vite Plugin
      • Electronegativity Plugin
      • Auto Unpack Native Modules Plugin
      • Local Electron Plugin
      • Fuses Plugin
    • Makers
      • AppX
      • deb
      • DMG
      • Flatpak
      • pkg
      • RPM
      • Snapcraft
      • Squirrel.Windows
      • WiX MSI
      • ZIP
    • Publishers
      • Bitbucket
      • Electron Release Server
      • GitHub
      • Google Cloud Storage
      • Nucleus
      • S3
      • Snapcraft
    • Hooks
  • Built-in Templates
    • Webpack
    • Webpack + Typescript
    • Vite
    • Vite + TypeScript
  • Guides
    • Code Signing
      • Signing a Windows app
      • Signing a macOS app
    • Custom App Icons
    • Framework Integration
      • React
      • React with TypeScript
      • Vue 3
    • Developing with WSL
  • Advanced
    • Auto Update
    • Debugging
    • Extending Electron Forge
      • Writing Plugins
      • Writing Templates
      • Writing Makers
      • Writing Publishers
    • API Docs
Powered by GitBook
On this page
  • Requirements
  • Installation
  • Usage
  • Debugging

Was this helpful?

Edit on GitHub
  1. Configuration
  2. Makers

AppX

Create a package for the Microsoft Store for your Electron app, using Electron Forge.

The AppX target builds .appx packages which are designed to target the Microsoft Store.

Requirements

You can only build the AppX target on Windows 10 or 11 machines with the Windows SDK installed. Check the electron-windows-store docs for more information on platform requirements.

Installation

npm install --save-dev @electron-forge/maker-appx

Usage

To use @electron-forge/maker-appx, add it to the makers array in your Forge configuration:

forge.config.js
module.exports = {
  makers: [
    {
      name: '@electron-forge/maker-appx',
      config: {
        publisher: 'CN=developmentca',
        devCert: 'C:\\devcert.pfx',
        certPass: 'abcd'
      }
    }
  ]
};

Configuration options are documented in MakerAppXConfig.

Debugging

For advanced debug logging for this maker, add the DEBUG=electron-windows-store* environment variable.

PreviousMakersNextdeb

Last updated 11 months ago

Was this helpful?