@mxenabled/rules-engine/README.md

UI for MX's rules engine Dwight

# Rules Engine

A React UI component library for MX's rules engine Dwight, built with TypeScript and Material-UI.

## Scripts

Get up and running
- **`yarn storybook`** - Starts the Storybook development server on port 6006 for component documentation and testing

- ** Shareable Storybook url ** - is located in the output of the pages step when you create an MR

Test your code
- **`yarn test`** - Runs the test suite using Vitest

Test publish your package
- **`yarn publish:alpha`** - Publishes the package to npm with the "alpha" tag for pre-release testing (ie 1.0.0-alpha.JB1)

Publish the real deal
- **`yarn publish:latest`** - Publishes the package to npm as the latest stable release

- **`yarn build`** - Compiles the TypeScript source code into distributable JavaScript using Rollup
- **`yarn build:watch`** - Runs the build process in watch mode, automatically rebuilding when files change
- **`yarn build:analyze`** - Builds the project with bundle analysis enabled to visualize the output size and dependencies
- **`yarn prepublishOnly`** - Automatically runs the build process before publishing to npm
- **`yarn publish:beta`** - Publishes the package to npm with the "beta" tag for beta releases
- **`yarn build-storybook`** - Builds a static version of Storybook to the compiled_docs directory
- **`yarn test:watch`** - Runs tests in watch mode, automatically re-running when files change
- **`yarn citest`** - Runs tests with coverage reporting for continuous integration environments
- **`yarn lint`** - Checks TypeScript and TSX files for code quality issues using ESLint
- **`yarn type-check`** - Validates TypeScript types without generating output files