Skip to content

Commit

Permalink
docs: add yarn command to create electron-app
Browse files Browse the repository at this point in the history
  • Loading branch information
403-html authored Aug 19, 2024
1 parent 71b7a31 commit a6e8a64
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions templates/typescript-+-webpack-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,18 @@ description: Create a new Electron app with webpack and TypeScript.

To get you up and running as fast as possible with [TypeScript](https://www.typescriptlang.org/) and [webpack](https://webpack.js.org/), we provide a template that makes use of the [`@electron-forge/plugin-webpack` module](../config/plugins/webpack.md) with sane TypeScript configuration defaults.

With npm:

```bash
npm init electron-app@latest my-new-app -- --template=webpack-typescript
```

With yarn:

```bash
yarn create electron-app my-new-app --template=webpack-typescript
```

{% hint style="warning" %}
There have been reports that using the Git Bash command line on Windows specifically with this template will prevent the Electron app from rendering (packaged apps are fine). We recommend that on Windows, you use CMD.exe, PowerShell, or [WSL2](../guides/developing-with-wsl.md).
{% endhint %}
Expand Down

0 comments on commit a6e8a64

Please sign in to comment.