Skip to content

Commit

Permalink
docs(create): Add troubleshooting section to new project readme(#2860)
Browse files Browse the repository at this point in the history
  • Loading branch information
callumhemming authored May 31, 2024
1 parent b54c210 commit e61c38d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions packages/create/templates/readme.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,14 @@ data that you cannot lose.
---
You can also run any pending migrations manually, without starting the server via the "vendure migrate" command.
---

## Troubleshooting

### Error: Could not load the "sharp" module using the \[OS\]-x\[Architecture\] runtime when running Vendure server.

- Make sure your Node version is ^18.17.0 || ^20.3.0 || >=21.0.0 to support the Sharp library.
- Make sure your package manager is up to date.
- **Not recommended**: if none of the above helps to resolve the issue, install sharp specifying your machines OS and Architecture. For example: `pnpm install sharp --config.platform=linux --config.architecture=x64` or `npm install sharp --os linux --cpu x64`

0 comments on commit e61c38d

Please sign in to comment.