Meta tags:

Headings (most frequently used words):

-

Text of the page (most frequently used words):
the (21), you (19), your (16), app (15), electron (14), forge (14), for (11), and (10), https (8), with (8), can (8), config (8), publishers (7), templates (7), documentation (6), are (6), advanced (6), using (6), bash (6), distributables (6), out (5), plugins (5), makers (5), npm (5), configuration (5), run (5), www (4), all (4), create (4), publishing (4), template (4), more (4), check (4), publish (4), github (4), electronforge (3), packaging (3), build (3), that (3), code (3), custom (3), own (3), node (3), com (3), javascript (3), yarn (3), pnpm (3), project (3), install (3), script (3), webpack (3), writing (3), have (3), share (3), make (3), publisher (3), complete (2), llms (2), txt (2), markdown (2), available (2), page (2), this (2), started (2), its (2), creating (2), git (2), package (2), hint (2), style (2), node_modules (2), when (2), dependencies (2), bundle (2), take (2), please (2), endhint (2), new (2), first (2), need (2), around (2), init (2), command (2), npx (2), latest (2), add (2), there (2), currently (2), typescript (2), vite (2), these (2), dev (2), extending (2), starting (2), now (2), basic (2), building (2), got (2), want (2), will (2), platform (2), specific (2), information (2), what (2), once (2), debugging (2), index, see, versions, pages, appending, urls, readme, getting, one, tool, distributing, applications, combines, many, single, purpose, packages, full, pipeline, works, box, signing, installers, artifact, workflows, logic, added, lifecycle, through, plugin, api, storage, targets, handled, prerequisites, nodejs, org, v16, scm, manager, npmjs, yarnpkg, warning, requires, disk, crawls, folder, collect, module, resolution, algorithm, naive, doesn, into, account, symlinked, nor, plug, play, pnp, format, use, nodelinker, modules, mode, set, linker, hoisted, npmrc, get, initialize, convenient, wrapper, cli, initialization, scripts, additional, name, flag, four, party, built, production, includes, server, provide, better, developer, experience, info, highly, recommend, initializing, advantage, modern, front, end, tooling, learn, about, authoring, guide, should, directory, called, files, start, amazing, application, world, generate, everyone, kind, users, then, method, choice, example, assets, dependency, save, configured, according, following, upload, support, usage, time, which, done, file, options, specified, docs, also, some, our, features, like, adding,

Text of the page (random words):
for the complete documentation index see llms txt https www electronforge io llms txt markdown versions of documentation pages are available by appending md to page urls this page is available as markdown https www electronforge io readme md getting started electron forge is an all in one tool for packaging and distributing electron applications it combines many single purpose packages to create a full build pipeline that works out of the box complete with code signing installers and artifact publishing for advanced workflows custom build logic can be added in the forge lifecycle through its plugin api config plugins md custom build and storage targets can be handled by creating your own makers config makers md and publishers config publishers md prerequisites node js https nodejs org v16 4 0 git https git scm com a javascript package manager npm https www npmjs com yarn https yarnpkg com pnpm https pnpm io as of forge v7 7 0 hint style warning packaging requires node_modules to be on disk when packaging your electron app forge crawls your project s node_modules folder to collect dependencies to bundle its module resolution algorithm is naive and doesn t take into account symlinked dependencies nor yarn s plug n play pnp format if you are using yarn 2 please use the nodelinker node modules install mode if you are using pnpm please set node linker hoisted in your project s npmrc configuration endhint creating a new app to get started with electron forge we first need to initialize a new project with create electron app this script is a convenient wrapper around forge s init cli md init command bash npx create electron app latest my app using templates forge s initialization scripts can add additional template code with the template template name flag bash npx create electron app latest my app template webpack there are currently four first party templates webpack webpack typescript vite vite typescript all of these templates are built around plugins that bundle your javascript code for production and includes a dev server to provide a better developer experience hint style info we highly recommend using these templates when initializing your app to take advantage of modern front end javascript tooling endhint to learn more about authoring your own templates for electron forge check out the writing templates advanced extending electron forge writing templates md guide starting your app you should now have a directory called my app with all the files you need for a basic electron app bash 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 config makers md documentation bash npm run make publishing your app now you have distributables that you can share with your users if you run the publish script electron forge will then publish the platform specific distributables for you using the publishing method of your choice for example if you want to publish your assets to github you can install the github publisher dependency using bash npm install save dev electron forge publisher github once you have configured the publisher according to the documentation config publishers github md run the following command to upload your distributables bash npm run publish for more information on what publishers we currently support check out the publishers config publishers md documentation advanced usage once you ve got a basic app starting building and publishing it s time to add your custom configuration which can be done in the forge config js file configuration options are specified in the configuration docs https www electronforge io configuration you can also check out the documentation on some of our more advanced features like adding plugins config plugins md debugging your app advanced debugging md writing your own makers publishers and plugins advanced extending electron forge md