From 9bbe1edbdac325013716b599a5bbd044ff100b78 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Thu, 6 Apr 2023 16:19:08 +0300 Subject: [PATCH] docs: added troubleshooting guide for cma (#3756) --- docs/content/create-medusa-app.mdx | 6 ++++++ .../troubleshooting/create-medusa-app-errors.md | 16 ++++++++++++++++ www/docs/sidebars.js | 5 +++++ 3 files changed, 27 insertions(+) create mode 100644 docs/content/troubleshooting/create-medusa-app-errors.md diff --git a/docs/content/create-medusa-app.mdx b/docs/content/create-medusa-app.mdx index 88c1fccd55..706f4dadf4 100644 --- a/docs/content/create-medusa-app.mdx +++ b/docs/content/create-medusa-app.mdx @@ -139,6 +139,12 @@ Please note that the `yarn dev` command is shown by default for storefronts and --- +## Troubleshooting + +If you run into any errors during the installation, please refer to [this troubleshooting guide](./troubleshooting/create-medusa-app-errors.md) for a potential help. + +--- + ## Project Directory Structure Inside the root project directory which was specified at the beginning of the installation process you’ll find the following directory structure: diff --git a/docs/content/troubleshooting/create-medusa-app-errors.md b/docs/content/troubleshooting/create-medusa-app-errors.md new file mode 100644 index 0000000000..8182c9df8e --- /dev/null +++ b/docs/content/troubleshooting/create-medusa-app-errors.md @@ -0,0 +1,16 @@ +# Common Create-React-App Errors + +## TypeError: cmd is not a function + +This error typically occurs when you set up a Medusa project with `create-medusa-app` and try to run the Medusa backend. + +To resolve this issue, make sure you change into the `backend` directory of the Medusa project you created before trying to start the Medusa backend: + +```bash npm2yarn +cd backend +npm run start +``` + +## Other Errors + +If you ran into another error, please try to search through [our GitHub issues](https://github.com/medusajs/medusa/issues) to see if there's a solution for your issue. If not, please [create an issue on GitHub](https://github.com/medusajs/medusa/issues/new?assignees=olivermrbl&labels=status:+needs+triaging,+type:+bug&template=bug_report.md&title=) and our team will help you resolve it soon. diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index b7a7739490..80ac5f55b8 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -293,6 +293,11 @@ module.exports = { type: "category", label: "Installation Errors", items: [ + { + type: "doc", + id: "troubleshooting/create-medusa-app-errors", + label: "Create Medusa App Errors", + }, { type: "doc", id: "troubleshooting/cli-installation-errors",