@asaleh37/ui-base 1.2.26 → 1.2.28

package/README.md

@@ -0,0 +1,52 @@
+**UI Base** is a React JS template designed for quickly scaffolding robust, production-ready Enterprise Applications Interface. It incorporates enterprise-grade architectural patterns and integrates a suite of essential features to accelerate development, including:
+
+- A modular, layered architecture with a clean separation of concerns and industry-standard project structure.
+
+- [ ] Create new react project using vite.
+
+```javascript
+npm create vite@latest YOUR_APP_NAME    //choose typescript as template
+cd YOUR_APP_NAME
+npm install
+```
+
+- [ ] Install the UI Base Dependency.
+
+```javascript
+npm install @asaleh37/ui-base --force
+```
+
+- [ ] replace the content of the file src/main.tsx
+
+```javascript
+import { BaseApp } from "@asaleh37/ui-base";
+import { createRoot } from "react-dom/client";
+
+createRoot(document.getElementById("root")!).render(
+  <BaseApp
+    apiBaseUrl="YOUR_API_URL"
+    appLogo={"YOUR_APP_LOGO_PATH"}
+    appName="YOUR_APP_NAME"
+    appVersion="YOUR_APP_VERSION"
+    businessCommonStoresMetaData={{}}
+    businessNavigationItems={[]}
+    businessReduxReducers={{}}
+    businessRoutes={[]}
+    documentTitle="YOUR_HTML_DOCUMENT_TITLE"
+    enableAdministrationModule={true}  // to enable administration module or not
+		/* // To Change APP Coloring Theme modify the following colors
+    appTheme={{
+      dark: { primaryColor: "#b3a10c", secondaryColor: "#2b3c46" },
+      light: { primaryColor: "#2b3c46", secondaryColor: "#b3a10c" },
+    }}
+		*/
+   muiPremiumKey="YOUR_MUI_PREMIUM_KEY"
+  />
+);
+```
+
+- [ ] then go to the root of your project and then run the following command	
+
+```javascript
+npm run dev
+```

package/dist/index.d.ts

@@ -45,12 +45,20 @@ type AppInfo = {
     appName: string | null;
     appVersion: string | null;
     appLogo: any | null;
-    businessRoutes: Array<SystemRoute>;
-    businessNavigationItems: Array<ExtendedTreeItemProps>;
-    businessReduxReducers: {
+    businessLocals?: {
+        ar: {
+            [key: string]: string;
+        };
+        en: {
+            [key: string]: string;
+        };
+    };
+    businessRoutes?: Array<SystemRoute>;
+    businessNavigationItems?: Array<ExtendedTreeItemProps>;
+    businessReduxReducers?: {
         [key: string]: Reducer<any>;
     };
-    businessCommonStoresMetaData: {
+    businessCommonStoresMetaData?: {
         [key: string]: StoreMetaData;
     };
     muiPremiumKey: string;