quantic

Coveo Quantic

Using the Library

How to use the Coveo Quantic Library

Install Coveo Quantic as a Salesforce unlocked package

Contributing

Create a Salesforce Developer Organization

• Sign up
• Use your @coveo.com email account. The username can be anything.

Setup SFDX CLI

Salesforce cli

• Run npm install --global @salesforce/cli@2.x
• Optional: Setup CLI autocomplete

Update SFDX CLI Plugins

• Run sf plugins update

Install VSCode Extension

Optionally install the VSCode Salesforce Extension Pack if you do not want use the equivalent Salesforce cli commands to setup.

Note Make sure you open the quantic project at the root (/packages/quantic/) in vscode in order for the extension to work properly.

Enable Dev Hub in Your Salesforce Organization

• Connect to your salesforce developer organization login
• From Setup, enter Dev Hub in the Quick Find box and select Dev Hub.
• To enable Dev Hub, click Enable

Authorize Your Dev Hub

• In VS Code, press Command + Shift P, enter sfdx, and select SFDX: Authorize a Dev Hub.
• You can also run this command from the command line. sf org login web --set-default-dev-hub --alias LWC-Hub
• Running this command opens a browser to the Salesforce login page. Enter your Salesforce username and password. Authorize only once, not every time you work on your project.

Single command run

• Make sure you are at the root of packages/quantic.
• Run npm run scratch:dev.
• You should now have a scratch org with Quantic and the test community deployed. Watch your commandline for the url to the examples community.

Or you can run the individual commands below.

Create a Default Scratch Org

• Make sure you are in the packages/quantic root folder.
• Run this command to create the default scratch org. npm run scratch:create.
• In VS Code, press Command + Shift P, enter sfdx, and select SFDX: Create a Default Scratch Org.
• You can also run this command from the command line. sf org create scratch --set-default --definition-file config/lws-enabled-scratch-def.json --alias Quantic__LWS_enabled
• Quantic__LWS_enabled is an alias for the scratch org that you can use in other Salesforce CLI commands. You can create any alias that you like.

Deploy the Quantic code

• Run this command from the command line. sf project deploy start --source-dir force-app/main.

Testing

Deploy the Quantic Examples Communities

Example components are available as Salesforce communities (Digital Experiences), allowing you to experiment with Quantic components in two separate environments: one with Lightning Web Security (LWS) enabled and one with LWS disabled.

To set up both communities in scratch orgs, run:

npm run setup:examples

This script creates, configures, and deploys everything required to have fully working examples in two scratch orgs:

• An org with LWS enabled.
• An org with LWS disabled.

At the end of the script, the URLs for the two communities are provided, as in the following example:

The 'Quantic Examples' community (LWS enabled) is ready, you can access it at the following URL:
https://your-salesforce-lws-enabled-scratch-org-instance.force.com/examples

The 'Quantic Examples' community (LWS disabled) is ready, you can access it at the following URL:
https://your-salesforce-lws-disabled-scratch-org-instance.force.com/examples

To open Cypress, run:
npm run e2e:watch

Once the community has been deployed, you can deploy the main or example components to a specific org only when needed by running the corresponding commands:

npm run deploy:main --target-org Quantic__LWS_enabled
npm run deploy:examples --target-org Quantic__LWS_enabled

You can replace Quantic__LWS_enabled with your target org alias. For example:

npm run deploy:main --target-org MyCustomOrg
npm run deploy:examples --target-org MyCustomOrg

Run Cypress for Quantic Components

Note Before attempting to run Cypress tests, make sure the Quantic Examples community is deployed as described in the previous section.

Note Cypress tests run on the org with LWS enabled, aliased as Quantic__LWS_enabled.

To learn how to add tests, see adding tests.

• All the tests will need to be under folder cypress/integration.

To open Cypress in browser mode, run:

npm run e2e:watch

To run Cypress tests directly in your console, run:

npm run e2e

To get the detailed report, run:

npm run e2e:detailed

Run Playwright for Quantic Components

Note Before attempting to run Playwright tests, make sure the Quantic Examples community is deployed as described in the previous section in both orgs, the one where LWS is enabled and the one where it is disabled.

Note For more information on how to add tests, please refer to our Quantic Testing Strategy, which provides detailed guidelines on testing Quantic components.

To run Playwright tests, run:

npm run e2e:playwright:

To run Playwright tests only for the scratch org where LWS is enabled, run:

npm run e2e:playwright:lws-enabled

To run Playwright tests only for the scratch org where LWS is disabled, run:

npm run e2e:playwright:lws-disabled

Run LWC unit tests for Quantic Components

To run LWC unit tests directly in your console, run:

npm run test:unit

To run specific file/components LWC unit tests directly in your console, run:

npm run test:unit -p force-app/main/default/lwc/nameOfComponent/

Use Quantic From Source

After you have cloned the repository and have run npm install, run the following commands:

• npm run build
• sf project deploy start --source-dir force-app/main/default

Other Useful Commands

• sf project deploy start --metadata LightningComponentBundle
• --metadata LightningComponentBundle can be changed for different types of "resources". To know which name, check the related meta.xml file for each type of resource.
• Create new web components. In VS Code, press Command + Shift P, enter sfdx, and select SFDX: Create Lightning Web Component.

Learn About LWC

• lwc.dev
• Components reference. Make sure you stay in the "Lightning web components section". Aura does not apply. Aura is the older UI library that is being deprecated by Salesforce.
• Lightning design system. Reference for styling, CSS utilities, icons, and more.