thiagoelg commented on code in PR #2953: URL: https://github.com/apache/incubator-kie-tools/pull/2953#discussion_r1978331428
########## packages/scesim-editor/README.md: ########## @@ -17,36 +17,57 @@ # Test Scenario Editor -This module will host the next generation of Test Scenario Editor (\*.scesim) files. -The implementation is currently in PROGRESS, therefore we don't recommend any usage at the current time. - -this README will be updated accordingly to its status. +This module hosts the Test Scenario Editor +The scope of this editor is to create, view and edit (\*.scesim) files. +Test Scenario is a technology that enables Apache KIE users who rely on the Decision Engine or the Rule Engine to +test their business logic defined in DMN or DRL files easily and efficiently. + +The Test Scenario Editor still doesn't fully support the DRL test case, the following table clarifies which feature are currently supported: + +| x | DRL | DMN | +| ---------- | ----------- | --- | +| **Create** | NO | YES | +| **View** | YES | YES | +| **Edit** | PARTIALLY\* | YES | + +> \* **NOTE** At this time, DRL-based Test Scenario file can be opened and partially edited, but not created. + +The editor is based on the following technology stack: + +- [Typescript](https://www.typescriptlang.org/) +- [React.js](https://react.dev/) +- [Patternfly](https://www.patternfly.org/) +- [Zustand](https://zustand-demo.pmnd.rs/) + [Immer](https://immerjs.github.io/immer/) frameworks to manage the editor's state + +# Project Structure + +Below, a brief description of the project's structure: + +| Directory | Description | +| -------------------- | ---------------------------------------------------------------------------------------------------- | +| `src` | Source root code. It contains the entrrypoint ´TestScenarioEditor` component. | +| `src/creation` | It contains the Test Scenario components used to create a new scesim file (i.e an empty scesim file) | +| `src/drawer` | It contains the Test Scenario components used in the right Drawer component of the editor | +| `src/externalModels` | It contains resources (Context) to manage external modules (DMN files) | +| `src/hook` | It contains custom hooks required for this module | +| `src/i18n` | It contains the editor's internationalization resources | +| `src/mutations` | It contains a set of functions that mutate the editor's state | +| `src/resources` | It contains a set of resources (e.g empty scesim file) | +| `src/sidebar` | It contains the Test Scenario's left sidebar component, which acts as the editor menu | +| `src/store` | It contains the Test Scenario Zunstand + Immer state and related resources. | +| `src/store` | It contains the Test Scenario's table component, inherited by the `boxed-expression-component` | +| `stories` | It contains the Storybook's stories and the Dev WebApp showcase | +| `test-e2e` | It contains the Playwright integration tests | ## How to build it Like most of the projects of this repository, pnpm and NodeJS are mandatory to build the project. Please refer to the -repository main README file to know more about the requested versions and installation steps. During the first project build, -don't forget to bootstrap the project by launching ONE of the following: - -- `pnpm bootstrap` -- `pnpm bootstrap -F @kie-tools/scesim-editor...` if you are interested to bootstrap this module only. - -It's recommended to run a `pnpm bootstrap` every time a change in any direct or indirect modules' `packages.json` is applied. - -To build the project type in your terminal ONE of the below commands: - -- `pnpm -F @kie-tools/scesim-editor... build:dev` This is fast, but not as strict. It skips tests, linters, and some type checks. Recommended for dev purposes. -- `pnpm -F @kie-tools/scesim-editor... build:prod` The default command to build production-ready packages. This is the recommended build for production purposes - -The above command will build `scesim-editor` module AND its direct and indirect dependencies modules. -To build the `scesim-editor` module ONLY, you can use ONE of the below commands: - -- `pnpm -F @kie-tools/scesim-editor build:dev` This is fast, but not as strict. It skips tests, linters, and some type checks. Recommended for dev purposes. -- `pnpm -F @kie-tools/scesim-editor build:prod` The default command to build production-ready packages. This is the recommended build for production purposes +repository main README file to know more about the requested versions and installation steps. ## How to launch the Test Scenario Storybook Dev WebApp After building the project, you can benefit of the Storybook Dev Webapp for development or testing scope. +The DevApp code lives in the `stories` directort Review Comment: ```suggestion The DevApp code lives in the `stories` directory. ``` -- 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]
