Skip to content

Commit

Permalink
GITBOOK-174: Erick's Nov 15 changes
Browse files Browse the repository at this point in the history
  • Loading branch information
erickzhao authored and gitbook-bot committed Nov 16, 2023
1 parent 2cdbf97 commit b3e5460
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 11 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,12 @@ Electron Forge is an all-in-one tool for packaging and distributing Electron 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.

{% hint style="warning" %}
Electron Forge 6 currently only supports Yarn Classic (v1.x) and npm. If you are using a newer version of Yarn, you can downgrade to Classic using the [`yarn set version`](https://yarnpkg.com/cli/set/version) command.
Electron Forge 7 currently only supports Yarn Classic (v1.x) and npm. If you are using a newer version of Yarn, you can downgrade to Classic using the [`yarn set version`](https://yarnpkg.com/cli/set/version) command.
{% endhint %}

```bash
npm init electron-app@latest my-app
```
{% hint style="warning" %}
If you used the `create-electron-app` script before during Forge `6.0.0-beta`, we recommend you uninstall the package globally before running the command again.

```bash
npm uninstall -g create-electron-app
```
{% endhint %}

### Using templates

Expand All @@ -35,12 +28,14 @@ Forge's initialization scripts can add additional template code with the `--temp
npm init electron-app@latest my-app -- --template=webpack
```

There are currently two first-party templates:
There are currently four first-party templates:

* `webpack`
* `webpack-typescript`
* `vite`
* `vite-typescript`

Both of these templates are built around the [Webpack Plugin](config/plugins/webpack.md), which bundles your JavaScript code for production and includes a dev server to provide a better development experience. The `webpack-typescript` template also wires up your project for TypeScript support.
Both 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.
Expand Down
2 changes: 1 addition & 1 deletion guides/code-signing/code-signing-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ For further reading on entitlements, see the following pages in Apple developer
Under the hood, Electron Forge uses the [`@electron/notarize`](https://github.com/electron/notarize) tool to notarize your macOS application.
{% endhint %}

The `osxNotarize` configuration object can be set up to either use the `legacy` or `notarytool` strategies. If you are using Xcode 13 or higher, we strongly recommend using `notarytool`. The `legacy` tooling will be removed when Apple sunsets `altool` (projected for Fall 2023).
The `osxNotarize` configuration object only supports `notarytool` as of Electron Forge v7.0.0.

The `notarytool` command has three authentication options, which are detailed below. Note that you will want to use a `forge.config.js` configuration so that you can load environment variables into your Forge config.

Expand Down

0 comments on commit b3e5460

Please sign in to comment.