:electron: A complete tool for building and publishing Electron applications
Перейти к файлу
Erick Zhao 0861161b25
make syncpack happy
2024-12-02 15:54:53 -08:00
.circleci chore: bump electronjs/node to 2.3.1 (main) (#3746) 2024-11-02 02:59:06 +00:00
.github build(deps): bump actions/setup-node from 4.0.4 to 4.1.0 (#3748) 2024-11-02 04:25:02 +00:00
.husky build: npm@9 removed the bin command (#3110) 2022-12-09 02:50:21 -08:00
.vscode fix: .vscode settings.json changes on open (#3460) 2024-01-09 16:37:14 -08:00
ci build: migrate from github actions to circleci (#3188) 2023-06-05 13:41:55 -07:00
packages make syncpack happy 2024-12-02 15:54:53 -08:00
tools docs: upgrade typedoc@0.25 (#3636) 2024-06-21 14:44:29 -07:00
typings fix(plugin-webpack): better webpack-dev-server types (#2952) 2022-10-12 12:49:08 -07:00
.editorconfig chore(core): add *.ts to .editorconfig (#527) 2018-07-06 11:35:26 +10:00
.eslintignore feat: esm forge.config.js support (#3358) 2023-11-02 14:14:08 -07:00
.eslintrc.json feat(plugin-vite): better logic (#3583) 2024-09-19 23:53:02 +00:00
.gitattributes chore: add `.gitattributes` file for proper handling of line endings (#3134) 2023-01-09 09:51:11 -08:00
.gitignore docs: upgrade typedoc@0.25 (#3636) 2024-06-21 14:44:29 -07:00
.markdownlint.json build: lint Markdown (#3247) 2023-06-09 17:29:13 -07:00
.markdownlintignore build: lint Markdown (#3247) 2023-06-09 17:29:13 -07:00
.mocharc.js ci: junit reporter adjustments (#3324) 2023-08-30 14:52:38 -07:00
.nvmrc chore: add `.nvmrc` for developers (#3704) 2024-09-19 21:25:35 +00:00
.prettierignore docs: upgrade typedoc@0.25 (#3636) 2024-06-21 14:44:29 -07:00
CHANGELOG.md chore: update CHANGELOG.md 2022-11-14 15:17:36 -08:00
CNAME Create CNAME 2022-08-22 13:31:54 -07:00
CONTRIBUTING.md docs: add notes on publishing a new monorepo package (#3415) 2023-11-17 20:03:01 -08:00
LICENSE docs(LICENSE): add a license file 2016-12-03 23:55:46 +11:00
README.md docs: remove mention of v5 -> v6 migration (#3412) 2023-11-17 11:52:27 -08:00
SUPPORT.md feat!: change electron-packager to @electron/packager (#3408) 2023-11-15 14:52:47 -08:00
lerna.json v7.5.0 2024-09-20 11:47:54 -07:00
nx.json build(deps): lerna@7 (#3706) 2024-09-19 21:46:30 +00:00
package.json fix: Bump @electron/rebuild to ^3.7.0 (#3732) 2024-10-08 19:52:26 +00:00
tsconfig.base.json build!: update minimum Node.js version from `14.17.5` to `16.0.0` (#3399) 2023-11-03 11:06:58 -07:00
tsconfig.test.json build!: update minimum Node.js version from `14.17.5` to `16.0.0` (#3399) 2023-11-03 11:06:58 -07:00
typedoc.base.json docs: upgrade typedoc@0.25 (#3636) 2024-06-21 14:44:29 -07:00
typedoc.json docs: upgrade typedoc@0.25 (#3636) 2024-06-21 14:44:29 -07:00
yarn.lock build(deps): bump http-proxy-middleware from 2.0.6 to 2.0.7 (#3745) 2024-11-02 04:25:15 +00:00

README.md

Electron Forge

CircleCI Discord npm version license status

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.