NICE CXone Component Framework (CCF)

Monorepo for SDKs, UI Controls, UI Components and agent applications

Running Locally

1. yarn install
   • If seeing Error "Couldn't find package" can be caused by npm private repsitory
   • Temporarily comment out .npmrc line
     registry=https://nice-devops-369498121101.d.codeartifact.us-west-2.amazonaws.com/npm/cxone-npm/
2. Search for // Dev Note: comments and comment out/in lines as noted.
3. Use NX Console to serve cxone-agent and cxone-agent-host projects, or execute in separate terminal windows
   • yarn nx serve cxone-agent-host
   • yarn nx serve cxone-agent
4. Open http://localhost:4200/

Development related folders

1. .storybook -> It contains root level configuration for storybook
2. .vscode -> It contains local vscode related config

Project folders

1. apps/ -> This contains different react applications which utilizes the sdk libs apps/cxone-agent -> It is for cxone-agent application
2. docs/ -> Contains nx project setup related documents
3. sdk-docs -> Contains source code documentations of SDK generated using type doc
4. libs -> Contains SDK source code libs/common -> Contains common source codes like code-sdk, agent-sdk etc. libs/react -> Contains common react specific codes like ui-components, ui-controls etc.
5. tools/generator -> Contains code that can be used as a utility to build, generate etc.

Important files

1. .eslintrc.json -> Configuration file used by eslint to identify included folders, excluded files and rules.
2. .gitignore -> File to specify the folders/files to be ignored by git
3. .nxignore -> Similar to .gitignore which can be used to specify folders to be ignored for nx commands
4. jest.config.js -> Configuration file for JEST
5. nx.json -> Config file that stores information like implicitDependencies,tasksRunnerOptions,targetDependencies and projects
6. package.json
7. tsconfig.base.json -> Typescript config file which is extended by individual tsconfig file used in individual libs. This files created as part of nx project setup.
8. tsconfig.json -> Config file which is mainly used by TypeDoc for identifying the files to generate documentation.
9. workspace.json -> This is the main file used by NX to specify all the configuration related to NX project structure. It contains all the project config details used in this repository.

Localisation Guides

Guide to Localisation. Click Here to Read More

Theming Guides

Guide to Theming, Palette and Surface Colors. Click Here to Read More

Unit Tests

Running

npm run test

Code Coverage

1. npm run coverage
2. Reports generated at webapp-acd-agent-apps/coverage/apps/
3. Choose an app folder to open
4. Open index.html

Application

Run CXAgent locally

1. Install Extension "Nx Console"
2. Open Nx Console
3. Expand cxone-agent -> serve -> click Play
4. Expand cxone-agent-host -> serve -> development -> click Play
5. Open http://localhost:4200/