README.md

Workflow Engine by Optimajet JavaScript Designer sample

This sample embeds Workflow Designer in a JavaScript application. The release archive pins its Workflow Designer dependencies to the packaged release. Framework versions are listed in package.json and locked in package-lock.json.

Prerequisites

• Node.js 24.22.0 and npm.
• A running Workflow Engine Designer API. Follow the backend installation guide.

Configure the sample

In src/index.js, set apiurl to your backend's Designer endpoint, for example http://localhost:5274/workflow-api/designer. Set schemeCode (schemecode in the JavaScript data object) to the scheme to open. The supplied demo configuration uses SimpleWF.

The checked-in configuration points to the public demo. Use your own backend for application data. Configure backend CORS for your frontend origin and apply your application's authentication and scheme access rules.

Run the sample

From this sample directory:

npm install
npm run build

Open the generated dist/index.html through a local web server. The Designer opens the selected scheme, or creates a new scheme when the backend does not contain it.

Build for hosting

npm run build

Documentation and support

• Designer integration
• Release notes
• Workflow Engine source and issues
• Technical questions: support@optimajet.com

Workflow Designer is distributed under the Workflow Engine EULA included in its npm package as LICENSE.md. Workflow Engine Free includes the full Designer within its limits and attribution terms.