@dynamic-framework/ui-react 2.0.0-dev.9 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,8 +1,57 @@
1
- # Dynamic Framework
1
+ # Dynamic UI
2
+
3
+ <!-- Badges -->
4
+ [![npm version](https://img.shields.io/npm/v/@dynamic-framework/ui-react?style=flat-square)](https://www.npmjs.com/package/@dynamic-framework/ui-react)
5
+ [![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)
6
+ [![npm downloads](https://img.shields.io/npm/dm/@dynamic-framework/ui-react?style=flat-square)](https://www.npmjs.com/package/@dynamic-framework/ui-react)
7
+ [![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)
8
+
2
9
 
3
10
  Quickly create feature-rich financial applications through a robust micro frontend architecture of React-based components with customizable templates built for integration.
4
11
 
12
+
5
13
  ## Getting Started
6
- Please follow the documentation at [dynamicbanking.co](https://dynamicbanking.co/)
7
14
 
8
- **Made with ❤️ by Modyo**
15
+ ### Installation
16
+
17
+ ```bash
18
+ npm install @dynamic-framework/ui-react
19
+ ```
20
+
21
+ For more details, visit the [npm package page](https://www.npmjs.com/package/@dynamic-framework/ui-react).
22
+
23
+ ### Development Commands
24
+
25
+ For local development and testing, you can use the following commands after clone the project:
26
+
27
+ - **Install deps:** Install required deps for development
28
+ ```bash
29
+ npm install
30
+ ```
31
+
32
+ - **Build:** Compiles the project for distribution.
33
+ ```bash
34
+ npm run build
35
+ ```
36
+ - **Test:** Runs all unit tests.
37
+ ```bash
38
+ npm test
39
+ ```
40
+ - **Test with Coverage:** Runs unit tests and generates a coverage report.
41
+ ```bash
42
+ npm run test:coverage
43
+ ```
44
+ - **Storybook:** Starts the Storybook development server to browse components.
45
+ ```bash
46
+ npm run storybook
47
+ ```
48
+
49
+ ### Documentation and Useful Links
50
+ - **Official Documentation:** Find guides and in-depth documentation at [docs.modyo.com/en/dynamic](https://docs.modyo.com/en/dynamic/).
51
+ - **Framework Website:** Visit our main site at [dynamicframework.dev](https://dynamicframework.dev).
52
+ - **Component Library:** Explore our components in Storybook at [react.dynamicframework.dev](https://react.dynamicframework.dev/).
53
+
54
+ <br />
55
+ <br />
56
+
57
+ **Made with 💚 by Modyo**