Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doc Troubleshooting problems in Faststore #1219

Merged
merged 2 commits into from
Apr 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
tags:
- performance
- troubleshooting
---

# Troubleshooting problems in FastStore

While developing with FastStore, you may run into errors. Some of these may require fixes in FastStore libraries, while others may require adjusting your code.

Hence, before proceeding with any advanced troubleshooting, we recommend that you first check if you are facing a bug from FastStore/WebOps or a mistake on your side.

## Step by step

1. Open the terminal and clone the [`base.store`](https://github.com/vtex-sites/base.store) repository.
```
npx degit vtex-sites/base.store
```
2. Change to the cloned repository and run `yarn`.
```
cd base.store && yarn
```
3. Open the `store.config.js` file and update the value of the `storeId` field with the account name of your store.
```diff
module.exports = {
platform: 'vtex',

api: {
+ storeId: {account}
environment: 'vtexcommercestable'
}
}
```
4. Start a local server.
```
yarn develop
```
5. Access [http://localhost:8000/](http://localhost:8000/) and test the features you are having trouble with.

If the problem persists with the `base.store` starter, we recommend [opening an issue](https://github.com/vtex/faststore/issues/new/choose) and reporting the problem. However, if the error only occurs in your own project, please refer to recommended resources (*Comming Soon*) to dive deeper into your code and try to find the origin of the error.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To complete this tutorial, you will need to have the following tools installed o
<summary>
<strong>Node.js</strong> - an open-source runtime environment that executes JavaScript code directly in a computer process instead of in a browser.
</summary>
To run your FastStore project, you must have <a href="https://nodejs.org/en/">Node.js</a> version 12.13 or later installed on your computer.
To run your FastStore project, you must have <a href="https://nodejs.org/en/">Node.js</a> version 14.19 or later installed on your computer.

<ul>
<li><a href="https://nodejs.org/tr/download/package-manager/#macos">Install Node.js on macOS using Homebrew</a></li>
Expand Down
12 changes: 12 additions & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,18 @@ module.exports = {
slug: 'how-to-guides',
},
items: [
{
type: 'category',
label: 'Local Development',
collapsed: false,
link: { type: 'generated-index', title: 'Local Development' , slug: 'how-to-guides/local-development' },
items: [
{
type: 'autogenerated',
dirName: 'how-to-guides/local-development',
},
],
},
{
type: 'category',
label: 'Platform Integration',
Expand Down
13 changes: 13 additions & 0 deletions docs/static/data/doc-update.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
[
{
"date": "2022-04-08",
"type": "Added",
"menu": "How-to Guides",
"category": "Local Development",
"path": "/how-to-guides/local-development",
"docs": [
{
"path": "/how-to-guides/local-development/troubleshooting-problems-in-faststore",
"title": "Troubleshooting problems in FastStore"
}
]
},
{
"date": "2022-04-07",
"type": "Added",
Expand Down