Fix getting started docs for windows users (#3703)

* Add note for trunk windows bug
This commit is contained in:
Jurrian Fahner 2025-03-26 08:28:16 +01:00 committed by GitHub
parent 4a28de483a
commit 57b29f20a4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 30 additions and 2 deletions

View File

@ -8,12 +8,26 @@ the boilerplate needed for a basic Yew app or manually set up a small project.
## Using a starter template
Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) by following their installation instructions
then run the following command:
then take the following steps:
### Checkout and customize project
```shell
cargo generate --git https://github.com/yewstack/yew-trunk-minimal-template
```
### Run project
```shell
trunk serve
```
:::note
Trunk [has a bug](https://github.com/trunk-rs/trunk/issues/852) on windows when `trunk serve` command fails. To workaround the issue you can run `trunk build` before running `trunk serve`.
:::
## Setting up the application manually
### Create Project

View File

@ -8,12 +8,26 @@ the boilerplate needed for a basic Yew app or manually set up a small project.
## Using a starter template
Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) by following their installation instructions
then run the following command:
then take the following steps:
### Checkout and customize project
```shell
cargo generate --git https://github.com/yewstack/yew-trunk-minimal-template
```
### Run project
```shell
trunk serve
```
:::note
Trunk [has a bug](https://github.com/trunk-rs/trunk/issues/852) on windows when `trunk serve` command fails. To workaround the issue you can run `trunk build` before running `trunk serve`.
:::
## Setting up the application manually
### Create Project