ubk.erp.webpack 1.0.7 → 1.0.9

package/README.md

@@ -1,96 +1,137 @@
-# ubk.erp.webpack
+# UBK ERP Component Library
 
-UBK internal React component library.
+A professional React component library for UBK ERP systems, built with Vite and Ant Design.
 
-## Installation
+## 🚀 Key Features
 
-You can install the package using npm:
+- **Modular Components**: Easily integrate ERP modules like Transport, Front Office, and Dashboards.
+- **Configurable Base URLs**: Support for configurable API and asset base URLs.
+- **Modern UI**: Styled with Ant Design for a consistent and professional look.
+- **TypeScript Support**: Full type definitions included.
+- **SWR Integration**: Efficient data fetching and caching out of the box.
+
+## 📦 Installation
+
+Install the package:
 
 ```bash
 npm install ubk.erp.webpack
 ```
 
-## Peer Dependencies
+### Peer Dependencies
+Ensure your project has the following installed:
+- `react` >= 18
+- `react-dom` >= 18
+- `@ant-design/icons` >= 5
+- `antd` >= 5
+- `dayjs` >= 1.11
+- `react-hot-toast` >= 2
+- `react-select` >= 5
+- `react-to-print` >= 3
+- `react-barcode` >= 1
+- `swr` >= 2
 
-Ensure you have the following peer dependencies installed in your project:
+## ⚙️ Configuration
 
-- `react` (>= 18)
-- `react-dom` (>= 18)
-- `antd` (>= 5)
-- `swr` (>= 2)
+The library determines the base URL for API calls and assets using the following priority (highest to lowest):
 
-## Menu Submenu
+1. **Manual Configuration**: Using the `setBaseUrl()` function in your code.
+2. **Environment Variable**: `VITE_ASSET_BASE_URL` in your `.env` file.
+3. **Default Fallback**: `https://npmapi.ubkerp.com/` (used if no other config is found).
 
-Here is a basic example of how to use the components provided by this library:
+### 1. Manual Setup (Recommended for NPM Users)
 
 ```jsx
-import React from 'react';
-import { MenuSubmenu } from "ubk.erp.webpack";
+import { setBaseUrl } from "ubk.erp.webpack";
 
+// Set your base URL once
+setBaseUrl("https://your-api-domain.com/");
+```
 
-const App = () => {
-  const token = "123";
-  return (
-    <div>
-      <MenuSubmenu token={token} menu={"FrontOffice"} />
-    </div>
-  );
-};
+### Environment Variables (Alternative)
 
-export default App;
-```
+If you prefer using environment variables, the library also supports:
+
+```env
+# Provide a full URL for asset/API base; if omitted the default
+# fallback `https://npmapi.ubkerp.com/` will be used.
+VITE_ASSET_BASE_URL=https://npmapi.ubkerp.com/
+REACT_APP_API_URL=https://npmapi.ubkerp.com/
 
-## Available Components
+# API Endpoints
+VITE_MENU_URL=api/sdk/Menus
+VITE_ADMISSION_ENQUIRY_URL=api/branchapi/frontoffice/enquirytablelist
+# Library endpoints (examples)
+VITE_LIBRARY_ADD_CATEGORY_URL=api/branchapi/library/addBookCategory
+VITE_LIBRARY_DELETE_CATEGORY_URL=api/branchapi/library/deleteBookCategory
+VITE_LIBRARY_MONTHLY_REPORT_URL=api/branchapi/library/libraryReport
+```
 
+## 🛠️ Usage
 
+### Basic Component Integration
 
-- `AdmissionEnquiry`
 ```jsx
-import { AdmissionEnquiry } from "ubk.erp.webpack";
+import React from 'react';
+import { MenuSubmenu } from "ubk.erp.webpack";
 
 const App = () => {
-  const token = "123";
+  const token = "YOUR_AUTH_TOKEN";
   return (
-    <div>
-      <AdmissionEnquiry token={token} type={'table'} />
-    </div>
+    <MenuSubmenu 
+      token={token} 
+      menu="FrontOffice" 
+    />
   );
 };
 
 export default App;
 ```
-`
-## Menu Transport
-- `Routes`
-```jsx
-import { TransportRoutes } from "ubk.erp.webpack";
 
-const App = () => {
-  const token = "123";
-  return (
-    <div>
-      <TransportRoutes token={token} />
-    </div>
-  );
-};
+### Using the Transport Module
 
-export default App;
-```
-- `Vehicles`
 ```jsx
-import { TransportVehicles } from "ubk.erp.webpack";
+import { TransportRoutes } from "ubk.erp.webpack";
 
-const App = () => {
-  const token = "123";
-  return (
-    <div>
-      <TransportVehicles token={token} />
-    </div>
-  );
+const TransportPage = () => {
+  return <TransportRoutes token="YOUR_TOKEN" />;
 };
-
-export default App;
 ```
 
+## 🧩 Available Components
+
+| Component | Description |
+| :--- | :--- |
+| `ErpDashboard` | Main dashboard overview. |
+| `MenuSubmenu` | Dynamic menu and navigation component. |
+| `AdmissionEnquiry` | Front office admission enquiry management. |
+| `TransportRoutes` | Manage transport routes and pricing. |
+| `TransportVehicles` | Vehicle fleet management. |
+| `AssignVehicles` | Assign vehicles to specific routes. |
+| `AddDriver` | Driver information and document management. |
+| `RouteTimeTable` | Schedule management for transport routes. |
+| `Stoppage` | Manage route stops and timings. |
+| `AddBook` | Library: add books. |
+| `BookList` | Library: book list + barcode printing. |
+| `IssueReturn` | Library: issue/return books. |
+| `LibraryAssignStudent` | Library: assign/remove student membership. |
+| `LibraryCategory` | Library: manage book categories. |
+| `LibraryReport` | Library: monthly report. |
+
+
+## 🛠️ Development
+
+### Setup
+1. Clone the repository
+2. Install dependencies: `npm install`
+3. Create a `.env` file and configure `VITE_*` variables as needed.
+
+### Build
+To build the library for production:
+```bash
+npm run build
+```
+This generates the `dist/` folder with ES and CommonJS formats.
 
-
+## 📄 License
+Internal UBK Project. All rights reserved.