thiagoelg commented on code in PR #2543: URL: https://github.com/apache/incubator-kie-tools/pull/2543#discussion_r1725748408
########## examples/dmn-editor-standalone-examples/README.md: ########## @@ -0,0 +1,75 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +## DMN Editor Standalone Examples + +A series of examples on how to use the DMN Editor Standalone in different applications. + +### Examples + +- [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 navigated 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 from the DMN Editor. + +### Build + +To build the examples, execute one of the following commands on the root folder of the project: + +```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 +``` Review Comment: The [root README](https://github.com/apache/incubator-kie-tools/blob/main/README.md) describes the bootstrap steps, as well as how to set up the necessary tools to build on kie-tools. Idk if we need to mention it here though, as that README should be the starting ground for everyone that's using the kie-tools repo. Maybe that's something we can discuss in this issue: https://github.com/apache/incubator-kie-issues/issues/866 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
