@data-netmonk/mona-chat-widget 2.1.29

package/README.md

@@ -0,0 +1,55 @@
+# Mona Chat Widget
+
+Chat widget package developed by Netmonk data & solution team to be imported in Netmonk products
+
+### Library (how to import on your project)
+
+---
+
+1. Install package
+   ```
+   npm install @aaiiccaa/mona-chat-widget
+   ```
+2. Import styles on your `App.jsx` or `index.jsx`
+
+   ```jsx
+   import "@aaiiccaa/mona-chat-widget/dist/style.css";
+   ```
+
+3. Import & use component
+
+   ```jsx
+   import { ChatWidget } from "@aaiiccaa/mona-chat-widget";
+
+   <ChatWidget type={"prime"} userId={"1234"} sourceId={"1"}/>;
+   ```
+
+---
+
+### Standalone app (for demonstration)
+
+1. **How to run locally** (access at `http://localhost:${PORT}/${APP_PREFIX}`)
+
+   ```
+   npm run dev
+   ```
+
+2. **How to build as a standalone app** (build file at `/dist-app` directory)
+
+   ```
+   npm run build-app
+   ```
+
+3. **How to serve standalone app** (access at `http://localhost:${PORT}/${APP_PREFIX}`)
+
+   ```
+   npm run serve
+   ```
+
+4. **How to run on docker** (access at `http://localhost:${PORT}/${APP_PREFIX}`)
+
+   ```
+   docker-compose up --build
+   ```
+
+---