YOTPO Reviews and Loyalty for SFRA

Yotpo reviews and loyalty integration for use with the Storefront Reference Architecture

Getting Started

1 Clone this repository.

2 Run npm install to install all of the local dependencies (node version 8.x or current LTS release recommended)

3 Create dw.json file in the root of the project:

{
    "hostname": "your-sandbox-hostname.demandware.net",
    "username": "yourlogin",
    "password": "yourpwd",
    "code-version": "version_to_upload_to",
    "storefront-username": "storefrontUsername",
    "storefront-password": "storefrontPassword"
}

4 Run npm run uploadCartridge command that will upload the int_yotpo_sfra and bm_yotpo cartridges to the sandbox you specified in dw.json file.

5 Add the int_yotpo_sfra cartridge to your cartridge path in Administration > Sites > Manage Sites > RefArch - Settings

6 Add the bm_yotpo and app_storefront_base cartridges to the business manager cartridge in Administration > Sites > Manage Sites > Business Manager - Settings

Note: This cartridge assumes the SFRA app_storefront_base cartridge has been uploaded to the code version.

Testing

Running unit tests

You can run npm test to execute all unit tests in the cartridge.

You can run npm run lint to verify code quality compliance

You can run npm run test:integration to execute all integration tests in the cartridge. These tests require a connection to the sandbox and expect the sample data to have been loaded The integration tests use your credentials from the dw.json file to connect to your sandbox.

Git pre-commit hooks for testing

Git can run the unit, initegration and lint tests for you before each commit. To enable this hook run

ln -s ../../test/preCommitHook.sh .git/hooks/pre-commit

Running acceptance tests

Running acceptance tests requires that the SFRA base cartridge and and metadata have been installed on your sandbox, and you have a working RefArch site. These tests expect that at least 1 order exists.

Acceptance tests are located in the yotpo-link/test/acceptance directory.

To run acceptance tests you can use the following command:

npm run test:acceptance

Note: Please note that this command will try to locate URL of your sandbox by reading dw.json file in the root directory of your project. If you don't have dw.json file, acceptance tests will fail.