2022-09-21 20:49:22 +00:00
|
|
|
# Distributing Apps With Electron Forge
|
|
|
|
|
|
|
|
Electron Forge is a tool for packaging and publishing Electron applications.
|
|
|
|
It unifies Electron's build tooling ecosystem into
|
|
|
|
a single extensible interface so that anyone can jump right into making Electron apps.
|
|
|
|
|
|
|
|
## Getting started
|
|
|
|
|
2023-01-16 09:22:49 +00:00
|
|
|
The [Electron Forge docs][] contain detailed information on taking your application
|
2022-09-21 20:49:22 +00:00
|
|
|
from source code to your end users' machines.
|
|
|
|
This includes:
|
|
|
|
|
2023-01-16 09:22:49 +00:00
|
|
|
* Packaging your application [(package)][]
|
|
|
|
* Generating executables and installers for each OS [(make)][], and,
|
|
|
|
* Publishing these files to online platforms to download [(publish)][].
|
2022-09-21 20:49:22 +00:00
|
|
|
|
2023-01-16 09:22:49 +00:00
|
|
|
For beginners, we recommend following through Electron's [tutorial][] to develop, build,
|
2022-09-21 20:49:22 +00:00
|
|
|
package and publish your first Electron app. If you have already developed an app on your machine
|
2023-01-16 09:22:49 +00:00
|
|
|
and want to start on packaging and distribution, start from [step 5][] of the tutorial.
|
2022-09-21 20:49:22 +00:00
|
|
|
|
|
|
|
## Getting help
|
|
|
|
|
|
|
|
* If you need help with developing your app, our [community Discord server][discord] is a great place
|
|
|
|
to get advice from other Electron app developers.
|
2023-01-16 09:22:49 +00:00
|
|
|
* If you suspect you're running into a bug with Forge, please check the [GitHub issue tracker][]
|
2022-09-21 20:49:22 +00:00
|
|
|
to see if any existing issues match your problem. If not, feel free to fill out our bug report
|
|
|
|
template and submit a new issue.
|
|
|
|
|
|
|
|
[Electron Forge Docs]: https://www.electronforge.io/
|
|
|
|
[step 5]: ./tutorial-5-packaging.md
|
|
|
|
[(package)]: https://www.electronforge.io/cli#package
|
|
|
|
[(make)]: https://www.electronforge.io/cli#make
|
|
|
|
[(publish)]: https://www.electronforge.io/cli#publish
|
2023-01-02 10:52:18 +00:00
|
|
|
[GitHub issue tracker]: https://github.com/electron/forge/issues
|
2022-09-21 20:49:22 +00:00
|
|
|
[discord]: https://discord.gg/APGC3k5yaH
|
2023-02-07 10:28:24 +00:00
|
|
|
[tutorial]: ./tutorial-1-prerequisites.md
|