-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added documentation about vtex install and Plug & Play disclaimer (#12)
- Loading branch information
Showing
2 changed files
with
30 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,7 +18,14 @@ a more complete search experience. | |
|
||
## Usage | ||
|
||
This app uses our store builder with the blocks architecture. To know more about Store Builder [click here.](https://help.vtex.com/en/tutorial/understanding-storebuilder-and-stylesbuilder#structuring-and-configuring-our-store-with-object-object) | ||
The first step to start using this app is to install it in the desired workspace, using: | ||
|
||
```sh | ||
vtex install [email protected] | ||
``` | ||
|
||
This app uses our store builder with the blocks architecture. | ||
To know more about Store Builder [click here.](https://help.vtex.com/en/tutorial/understanding-storebuilder-and-stylesbuilder#structuring-and-configuring-our-store-with-object-object) | ||
|
||
To use this app you need to import it in your dependencies on the `manifest.json`. | ||
|
||
|
@@ -76,6 +83,20 @@ passing them to the `hiddenOptions` prop on the `order-by` component. | |
} | ||
``` | ||
|
||
### Plug & Play | ||
|
||
For our app to be as _Plug & Play_ as possible it's necessary to follow the good conventions for developing | ||
[`store-themes`](https://github.com/vtex-apps/store-theme) like using open-source components developed by | ||
the [`vtex-apps`](https://github.com/vtex-apps) organization. | ||
|
||
Our app is heavily dependent, as seen above, on two major components: [`search-bar`](https://github.com/vtex-apps/store-components/blob/master/docs/SearchBar.md) | ||
and [`search-result`](https://vtex.io/docs/app/vtex.search-result). Our components are developed with the default | ||
implementations in mind, so keep that in mind when using custom components. For custom or closed-source components | ||
to work perfectly with our own, it should resemble both these components as closely as possible. | ||
|
||
If you're using any type of custom components on your `store-theme` we can't guarantee the _Plug & Play_ | ||
functionality of the components provided by this app. | ||
|
||
### Catalog Integration | ||
|
||
For this new search experience to work properly a Token and App Key need to be generated and sent | ||
|