From 87fd696691cf1eeab7a842224b55773d8b2bb97c Mon Sep 17 00:00:00 2001 From: Tiago Bento Date: Mon, 4 Nov 2024 21:50:26 -0500 Subject: [PATCH] .. --- .../bpmn-editor-classic-on-webapp/README.md | 10 +++++++++- .../dmn-editor-classic-on-webapp/README.md | 10 +++++++++- examples/dmn-editor-on-webapp/README.md | 10 +++++++++- .../dmn-editor-standalone-on-webapp/README.md | 19 ++++++++----------- .../README.md | 4 ++-- .../README.md | 10 +++++++++- .../README.md | 14 ++++++++++++++ .../README.md | 16 ++++++++++++++-- .../README.md | 10 +++++++++- .../README.md | 10 +++++++++- .../README.md | 16 ++++++++++++++-- .../README.md | 10 +++++++++- 12 files changed, 115 insertions(+), 24 deletions(-) diff --git a/examples/bpmn-editor-classic-on-webapp/README.md b/examples/bpmn-editor-classic-on-webapp/README.md index 338c5012bae..71ba25c808c 100644 --- a/examples/bpmn-editor-classic-on-webapp/README.md +++ b/examples/bpmn-editor-classic-on-webapp/README.md @@ -19,7 +19,15 @@ This package contains a web application that features the BPMN Editor (classic) as a wrapped inside a Micro-frontend Multiplying Architecture Envelope. -## Running +### Building the dependencies + +Before running this example, building its dependencies is required. Run the following command on a Terminal: + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/bpmn-editor-classic-on-webapp^... build:dev +``` + +### Running ```shell script pnpm start diff --git a/examples/dmn-editor-classic-on-webapp/README.md b/examples/dmn-editor-classic-on-webapp/README.md index 7bd1d089c4b..4345dd2fad4 100644 --- a/examples/dmn-editor-classic-on-webapp/README.md +++ b/examples/dmn-editor-classic-on-webapp/README.md @@ -19,7 +19,15 @@ This package contains a web application that features the DMN Editor (classic) as a wrapped inside a Micro-frontend Multiplying Architecture Envelope. -## Running +### Building the dependencies + +Before running this example, building its dependencies is required. Run the following command on a Terminal: + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/dmn-editor-classic-on-webapp^... build:dev +``` + +### Running ```shell script pnpm start diff --git a/examples/dmn-editor-on-webapp/README.md b/examples/dmn-editor-on-webapp/README.md index 69de18a4fe9..16550f0b7ac 100644 --- a/examples/dmn-editor-on-webapp/README.md +++ b/examples/dmn-editor-on-webapp/README.md @@ -19,7 +19,15 @@ This package contains a web application that features the DMN Editor as a wrapped inside a Micro-frontend Multiplying Architecture Envelope. -## Running +### Building the dependencies + +Before running this example, building its dependencies is required. Run the following command on a Terminal: + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/dmn-editor-on-webapp^... build:dev +``` + +### Running ```shell script pnpm start diff --git a/examples/dmn-editor-standalone-on-webapp/README.md b/examples/dmn-editor-standalone-on-webapp/README.md index 87c46bb51d2..bb27ac93c43 100644 --- a/examples/dmn-editor-standalone-on-webapp/README.md +++ b/examples/dmn-editor-standalone-on-webapp/README.md @@ -19,25 +19,22 @@ A series of examples on how to use the DMN Editor (standalone) in different applications. -- [State Control]("src/stateControl/index.ts"): Shows how to leverage the Editor API to undo/redo changes to a Decision, get its contents, and download an SVG of the diagram. -- [Read Only]("src/readOnly/index.ts"): Loads the editor in "Read Only" mode, where a decision can be displayed and explored but not changed. -- [With Included Models]("src/withIncludedModels/index.ts"): Displays how Decisions can be imported into other Decisions as "Included Models", using the `resources` parameter of DMN Editor (standalone). +- [State Control](src/stateControl/index.ts): Shows how to leverage the Editor API to undo/redo changes to a Decision, get its contents, and download an SVG of the diagram. +- [Read Only](src/readOnly/index.ts): Loads the editor in "Read Only" mode, where a decision can be displayed and explored but not changed. +- [With Included Models](src/withIncludedModels/index.ts): Displays how Decisions can be imported into other Decisions as "Included Models", using the `resources` parameter of DMN Editor (standalone). -### Build +### Building the dependencies -To build the examples, execute one of the following commands on the root folder of the project: +Before running this example, building its dependencies is required. Run the following command on a Terminal: ```shell script -KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/dmn-editor-standalone-examples... build:dev -KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/dmn-editor-standalone-examples... build:prod +KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/dmn-editor-standalone-on-webapp^... build:dev ``` -### Run - -To start the examples application, execute the following command on the root folder of the project: +### Running ```shell script -pnpm -F @kie-tools-examples/dmn-editor-standalone-examples start +pnpm -F @kie-tools-examples/dmn-editor-standalone-on-webapp start ``` Open http://localhost:9102 to see the list of files bundled by Webpack, then choose an example: diff --git a/examples/kie-sandbox-commit-message-validation-service/README.md b/examples/kie-sandbox-commit-message-validation-service/README.md index 6cd7d157ec3..8a4c7f7d4bd 100644 --- a/examples/kie-sandbox-commit-message-validation-service/README.md +++ b/examples/kie-sandbox-commit-message-validation-service/README.md @@ -19,7 +19,7 @@ Provides a simple service to check for patterns in a commit message. -## Environment Variables +### Environment Variables - `KIE_TOOLS_EXAMPLE__KIE_SANDBOX_COMMIT_MESSAGE_VALIDATION_SERVICE__port ` @@ -29,7 +29,7 @@ Provides a simple service to check for patterns in a commit message. Enables and configures validators. The value is a list of `;` separated validators that are parameterized with anything after `:`. e.g.: `Length:5-72;IssuePrefix:kie-issues#*` will enable the Lenght validator, with min 5 and max 72 characters, and will also enable the IssuePrefix validator, with the prefix pattern being `kie-issues#*`. -## Running +### Running ```shell script pnpm start diff --git a/examples/micro-frontends-multiplying-architecture-base64png-editor-chrome-extension/README.md b/examples/micro-frontends-multiplying-architecture-base64png-editor-chrome-extension/README.md index 2a5d5897956..001d1554635 100644 --- a/examples/micro-frontends-multiplying-architecture-base64png-editor-chrome-extension/README.md +++ b/examples/micro-frontends-multiplying-architecture-base64png-editor-chrome-extension/README.md @@ -19,7 +19,15 @@ Allows seeing `.base64png` files directly in GitHub's website. -## Running +### Building the dependencies + +Before running this example, building its dependencies is required. Run the following command on a Terminal: + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/micro-frontends-multiplying-architecture-base64png-editor-chrome-extension^... build:dev +``` + +### Running First, run this command on your Terminal. It will build the Chrome Extension and start an HTTP server acting as the hosting application for the Base64 Editor Envelope. diff --git a/examples/micro-frontends-multiplying-architecture-base64png-editor-on-webapp/README.md b/examples/micro-frontends-multiplying-architecture-base64png-editor-on-webapp/README.md index 884826bf08d..66de02e7dd0 100644 --- a/examples/micro-frontends-multiplying-architecture-base64png-editor-on-webapp/README.md +++ b/examples/micro-frontends-multiplying-architecture-base64png-editor-on-webapp/README.md @@ -17,6 +17,20 @@ # Example :: Micro-frontends Multiplying Architecture :: Base64 PNG Editor on webapp +### Building the dependencies + +Before running this example, building its dependencies is required. Run the following command on a Terminal: + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/micro-frontends-multiplying-architecture-base64png-editor-on-webapp^... build:dev +``` + +### Running + +```shell script +pnpm start +``` + --- Apache KIE (incubating) is an effort undergoing incubation at The Apache Software diff --git a/examples/micro-frontends-multiplying-architecture-base64png-editor-vscode-extension/README.md b/examples/micro-frontends-multiplying-architecture-base64png-editor-vscode-extension/README.md index 24d5fc125e4..b6c3fd49fdd 100644 --- a/examples/micro-frontends-multiplying-architecture-base64png-editor-vscode-extension/README.md +++ b/examples/micro-frontends-multiplying-architecture-base64png-editor-vscode-extension/README.md @@ -26,9 +26,21 @@ To make it easier to create `.base64png` files and exporting them to other forma 1. `Base64 PNG: Save as SVG` - When a `.base64png` is open, you can click the little SVG icon at the top-right corner of the Editor, or run it from the command palette. A new SVG file will be created at the same directory as the `.base64png` file. -## Building +### Building the dependencies -Run `KIE_TOOLS_BUILD__buildExamples=true pnpm build:prod`. A `.vsix` file will be on the `dist` folder. Drag it to the Extensions panel on VS Code to install it. +Before running this example, building its dependencies is required. Run the following command on a Terminal: + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/micro-frontends-multiplying-architecture-base64png-editor-vscode-extension^... build:dev +``` + +### Building + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm build:prod +``` + +A `.vsix` file will be on the `dist` folder. Drag it to the Extensions panel on VS Code to install it. --- diff --git a/examples/micro-frontends-multiplying-architecture-ping-pong-views-on-webapp/README.md b/examples/micro-frontends-multiplying-architecture-ping-pong-views-on-webapp/README.md index 30572997469..fb4676ee0d3 100644 --- a/examples/micro-frontends-multiplying-architecture-ping-pong-views-on-webapp/README.md +++ b/examples/micro-frontends-multiplying-architecture-ping-pong-views-on-webapp/README.md @@ -19,7 +19,15 @@ This package contains a web application that features multiple ways of using Ping-Pong Views wrapped inside Micro-frontends Multiplying Architecture Envelopes, showcasing both Promises and Notifications features of Multiplying Architecture Channel and Envelope APIs. -## Starting the application +### Building the dependencies + +Before running this example, building its dependencies is required. Run the following command on a Terminal: + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-views-on-webapp^... build:dev +``` + +### Running ```shell script pnpm start diff --git a/examples/micro-frontends-multiplying-architecture-todo-list-view-on-webapp/README.md b/examples/micro-frontends-multiplying-architecture-todo-list-view-on-webapp/README.md index bd199a1e406..6d884eff7be 100644 --- a/examples/micro-frontends-multiplying-architecture-todo-list-view-on-webapp/README.md +++ b/examples/micro-frontends-multiplying-architecture-todo-list-view-on-webapp/README.md @@ -19,7 +19,15 @@ This package contains a web application that features a 'To do' List View, a simple component wrapped inside an Envelope with a simple API for manging 'To do' items. It also features a very simple demo of Multiplying Architecture's Shared Value. -## Starting the application +### Building the dependencies + +Before running this example, building its dependencies is required. Run the following command on a Terminal: + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view-on-webapp^... build:dev +``` + +### Running ```shell script pnpm start diff --git a/examples/micro-frontends-multiplying-architecture-todo-list-view-vscode-extension/README.md b/examples/micro-frontends-multiplying-architecture-todo-list-view-vscode-extension/README.md index f7653905b71..95ebfb6b0bd 100644 --- a/examples/micro-frontends-multiplying-architecture-todo-list-view-vscode-extension/README.md +++ b/examples/micro-frontends-multiplying-architecture-todo-list-view-vscode-extension/README.md @@ -26,9 +26,21 @@ This package provides a VS Code Extension containing a 'To do' List View, which 1. `TODO: Mark all as completed` - Marks all the items in the 'To do' List as completed. -## Building +### Building the dependencies -Run `KIE_TOOLS_BUILD__buildExamples=true pnpm build:prod`. A `.vsix` file will be on the `dist` folder. Drag it to the Extensions panel on VS Code to install it. +Before running this example, building its dependencies is required. Run the following command on a Terminal: + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view-vscode-extension^... build:dev +``` + +### Building + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm build:prod +``` + +A `.vsix` file will be on the `dist` folder. Drag it to the Extensions panel on VS Code to install it. --- diff --git a/examples/serverless-workflow-editor-standalone-on-webapp/README.md b/examples/serverless-workflow-editor-standalone-on-webapp/README.md index 14d67970214..14e42f442d5 100644 --- a/examples/serverless-workflow-editor-standalone-on-webapp/README.md +++ b/examples/serverless-workflow-editor-standalone-on-webapp/README.md @@ -19,7 +19,15 @@ This package contains a web application that features the Serverless Workflow Diagram Editor Standalone. -## Running +### Building the dependencies + +Before running this example, building its dependencies is required. Run the following command on a Terminal: + +```shell script +KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/serverless-workflow-editor-standalone-on-webapp^... build:dev +``` + +### Running ```shell script pnpm start