Instead of nodejs, you can use nvm to better handle/manage multiple node versions on your computer.
This project relies on Node.js to build and run. It has been tested with version 16.
Under _Setup, we are providing instructions to help set up a Coveo org to be used with this storefront UI.
To run the development server:
npm install
npm run devOpen http://localhost:3000 with your browser to see the result.
You will get empty results until you set up your config (see next section).
In order to 'configure' the store, you can configure the next.config.js.
Here you can specify the following:
| Key | Description |
|---|---|
| env > ORG_ID | The Organization Id |
| env > API_KEY | The Seach API Key (should also have write access to Analytics events, see below) |
| env > SEARCH_PIPELINE | Pipeline for search |
| publicRuntimeConfig > logo | Logo to display in the Header |
| publicRuntimeConfig > title | Title to display in the Header |
| publicRuntimeConfig > searchhubPDP | Search hub for the Product Detail Page |
| publicRuntimeConfig > fields | Extra fields to return with the search response |
| publicRuntimeConfig > facetFields | Additional facets to show for this store array of: { field: 'ec_processor_model_number', label: 'Processor Model' } |
To perform Search against the Coveo index, you need an API key to authenticate the requests from the storefront.
In the Coveo Administration console, go in Organization / API keys and create a new API key for search, with these privileges:
- Under Analytics, set
Analytics Datato Push - Under Analytics, set
Impersonateto Allowed - Under Search, set
Execute Queriesto Allowed
To learn more about Coveo platform:
The storefront is implemented with Next.js. To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.