From cc0d9df6eb07041657773173fdf34a35a0926988 Mon Sep 17 00:00:00 2001 From: callumhemming Date: Wed, 22 May 2024 00:23:15 +0100 Subject: [PATCH] docs(fix): changed section to generated file --- README.md | 9 --------- packages/create/templates/readme.hbs | 9 +++++++++ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 821b886b57..33ce70b2de 100644 --- a/README.md +++ b/README.md @@ -173,15 +173,6 @@ Finally the command will create changelog entries for this release. The reason we do not rely on Lerna to push the release to Git is that this repo has a lengthy pre-push hook which runs all tests and builds the admin ui. This long wait then invalidates the npm OTP and the publish will fail. So the solution is to publish first and then push. -### 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` - - ## License MIT diff --git a/packages/create/templates/readme.hbs b/packages/create/templates/readme.hbs index 25ace11ee7..dec380c439 100644 --- a/packages/create/templates/readme.hbs +++ b/packages/create/templates/readme.hbs @@ -117,6 +117,15 @@ can set `dbConnectionOptions.synchronize` to `true`. This will cause the databas on each start, removing the need for migration files. Note that this is **not** recommended once you have production data that you cannot lose. +## 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` + --- You can also run any pending migrations manually, without starting the server via the "vendure migrate" command. +