Create a new OneCX app

The fastest way to create a new OneCX app is to use the OneCX generator. Some projects have their own generator based on the OneCX generator. It should be clarified before starting if this is the case for the project the app is generated for.

The generator supports three flavors of projects: angular, with and without NgRx. It is recommended to use the NgRx flavor because it leads to better structured projects and currently the support in the generator is better for the NgRx flavor. If you plan not to use any onecx-services and build a standalone app with the components of OneCX, please use ngrx-standalone.

To run the generator, execute the following commands:

npx <namespaceOfTheGenerator>/create-workspace <flavor> <nameOfTheProduct>
npm install

  • <namespaceOfTheGenerator>: For the OneCX generator, use @onecx. For a project specific generator, ask for the namespace of the generators.

  • <flavor>: ngrx, ngrx-standalone or angular.

  • <nameOfTheProduct>: The name of the product to create e.g., theme-mgmt.

After running the generator take the following actions:

  1. Check for further actions

  2. Commit the changes

Next you might want to generate a feature as this is a preqrequisite to generate a search / details page and more.