# Dynamic UI

<!-- Badges -->
[![npm version](https://img.shields.io/npm/v/@dynamic-framework/ui-react?style=flat-square)](https://www.npmjs.com/package/@dynamic-framework/ui-react)
[![Build & Publish](https://img.shields.io/github/actions/workflow/status/dynamic-framework/dynamic-ui/release-please.yml?style=flat-square)](https://github.com/dynamic-framework/dynamic-ui/actions/workflows/release-please.yml)
[![npm downloads](https://img.shields.io/npm/dm/@dynamic-framework/ui-react?style=flat-square)](https://www.npmjs.com/package/@dynamic-framework/ui-react)
[![License](https://img.shields.io/badge/License-DynamicFramework-blue?style=flat-square)](https://raw.githubusercontent.com/dynamic-framework/dynamic-ui/refs/heads/master/LICENSE.md)


Quickly create feature-rich financial applications through a robust micro frontend architecture of React-based components with customizable templates built for integration.


## Getting Started

### Installation

```bash
npm install @dynamic-framework/ui-react
```

For more details, visit the [npm package page](https://www.npmjs.com/package/@dynamic-framework/ui-react).

### Development Commands

For local development and testing, you can use the following commands after clone the project:

-   **Install deps:** Install required deps for development
    ```bash
    npm install
    ```

-   **Build:** Compiles the project for distribution.
    ```bash
    npm run build
    ```
-   **Test:** Runs all unit tests.
    ```bash
    npm test
    ```
-   **Test with Coverage:** Runs unit tests and generates a coverage report.
    ```bash
    npm run test:coverage
    ```
-   **Storybook:** Starts the Storybook development server to browse components.
    ```bash
    npm run storybook
    ```

### Documentation and Useful Links
- **Official Documentation:** Find guides and in-depth documentation at [docs.modyo.com/en/dynamic](https://docs.modyo.com/en/dynamic/).
- **Framework Website:** Visit our main site at [dynamicframework.dev](https://dynamicframework.dev).
- **Component Library:** Explore our components in Storybook at [react.dynamicframework.dev](https://react.dynamicframework.dev/).

<br />
<br />

**Made with 💚 by Modyo**