Add Webpack App UI Manually to OneCX

When you have created a custom application and want to run it in the OneCX local environment, you need to add the application to the OneCX. This involves adding the application to the product store, adding the application to the workspace, and assigning permissions and roles for accessing the application.

This guide is created for webpack module apps. To see all supported types of microservices, see the Microservices and Microfrontends documentation.

Alternatively you can use local-env-cli to add your application to the OneCX local environment. See local-env-cli for more details.

Prerequisites

Before you can add your custom application to the OneCX, you need to have the following prerequisites in place:

  • Your app needs to have webpack module federation implemented. See the Module Federation with Webpack documentation for details on how to implement webpack module federation in your application.

  • You have to add custom micro frontends to the OneCX local environment with ./toggle-mfe script.

Guide Steps

  1. Add the application and UI component to the product store

  2. Add the application to the workspace

  3. Assign permissions and roles (Optional)

Like all manual changes in the local environment, manually created applications will be lost when the Postgres volume is deleted (e.g. by running ./stop-onecx.sh -c).