Coveo UI Kit

Projects

• Headless: Stateful middle-layer between UI elements and the Coveo Platform.
• Atomic: Coveo's web-component library for building modern search experiences.
• Quantic: Coveo's LWC library for building Salesforce search experiences.
• Bueno: A simple schema validator.
• Auth: Functions to help authenticate with the Coveo platform.
• Headless React Samples: Various code samples using Headless inside a React application.

Install

To install all dependencies and link local packages, run:

npm i

To install a dependency in a specific package, specify the workspace:

npm i lodash -w @coveo/headless-react-samples

Build

To build all projects for production, run:

npm run build

To build a single project for production (for instance, the atomic package), run:

npx nx run atomic:build

Development mode

To start Atomic & Headless simultaneously in development (recommended), run:

npx nx run atomic:dev

To start a single project in development (for instance, the quantic package), run:

npx nx run quantic:dev

To run a specific task in a package separate it with colon e.g. to run test:watch inside quantic

npx nx run quantic:test:watch

To start story book in development, run:

npx nx run atomic-storybook:dev

Test

To run the tests for a specific package (recommended) e.g. atomic package

npx nx run atomic:test

For e2e tests

npx nx run atomic:dev
# In a separate terminal
npx nx run atomic:e2e

To run e2e tests for specific files/components using the Cypress GUI

npx nx run atomic:e2e:watch

Lint

npm run lint:check
npm run lint:fix

Misc

The project uses git hooks with Husky. You can make sure hooks are correctly installed using the npm rebuild command.

The following Visual Studio Code extensions are recommended:

• ESLint
• Prettier