From e61c38dea5031ef29bb28337fcc890b5048dcaed Mon Sep 17 00:00:00 2001 From: callumhemming <82006291+callumhemming@users.noreply.github.com> Date: Fri, 31 May 2024 11:07:56 +0100 Subject: [PATCH] docs(create): Add troubleshooting section to new project readme(#2860) --- packages/create/templates/readme.hbs | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/packages/create/templates/readme.hbs b/packages/create/templates/readme.hbs index 25ace11ee7..d1e9f601cd 100644 --- a/packages/create/templates/readme.hbs +++ b/packages/create/templates/readme.hbs @@ -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` +