procode-lowcode-core 1.0.0

package/README.md

@@ -0,0 +1,188 @@
+# ProCode Core
+
+A comprehensive React framework library for building low-code applications with powerful UI components, data management, and extensible architecture.
+
+## Installation
+
+```bash
+npm install procode-core
+```
+
+## Usage
+
+### Default Export - Core Component
+
+The main React component that bootstraps your ProCode application:
+
+```tsx
+import React from 'react';
+import Core, { CoreProps } from 'procode-core';
+
+const App: React.FC = () => {
+  const coreProps: CoreProps = {
+    // Configure your ProCode application
+    adapterProvider: yourAdapterProvider,
+    viewModelHandler: yourViewModelHandler,
+    // ... other configuration
+  };
+
+  return <Core {...coreProps} />;
+};
+
+export default App;
+```
+
+### Interfaces and Types
+
+Import all interfaces and types for TypeScript development:
+
+```tsx
+// Import all interfaces
+import { Interfaces } from 'procode-core';
+
+// Or import specific interfaces
+import { 
+  IActionFactory, 
+  IAdapterProvider, 
+  CoreProps,
+  BaseScreenElement,
+  ScreenSchema 
+} from 'procode-core';
+```
+
+### Styles
+
+Import the core styles in your application:
+
+```scss
+// Import all core styles
+@import 'procode-core/styles';
+
+// Or import specific base styles
+@import 'procode-core/styles/core-base';
+```
+
+```tsx
+// In JavaScript/TypeScript, you can get the style paths
+import { getCoreStylesPath, getCoreBaseStylesPath } from 'procode-core';
+
+console.log(getCoreStylesPath()); // './Assets/styles/index.scss'
+console.log(getCoreBaseStylesPath()); // './Assets/styles/_core-base.scss'
+```
+
+## Key Features
+
+### 🎯 **Core Component**
+- **Default Export**: `Core` - Main React component for bootstrapping ProCode applications
+- **Type-safe Props**: `CoreProps` interface for comprehensive configuration
+
+### 🔧 **Interfaces & Types**
+- **Action Interfaces**: `IActionFactory`, `StandardActionType`
+- **Adapter Interfaces**: `IAdapterProvider`, `AdapterType`
+- **Data Model Interfaces**: `IViewModelHandler`, `QueryFilters`, `ViewModel`
+- **UI Element Definitions**: `BaseScreenElement`, `ScreenSchema`, `WidgetElement`
+- **Validation Interfaces**: `IValidationFactory`, `ValidationFcResponse`
+
+### 🎨 **Styling System**
+- **Core Base Styles**: Essential styles for ProCode components
+- **Modular SCSS**: Import specific style modules as needed
+- **Container Renderer**: Layout and container styling
+- **Loading Components**: Spinner and skeleton loaders
+- **Drawer Components**: Overlay and drawer styling
+
+### 📊 **Data Management**
+- **View Model Handling**: Comprehensive data binding and state management
+- **CRUD Services**: Built-in services for data operations
+- **Query Filters**: Advanced filtering and querying capabilities
+- **Event Service**: Pub/sub event system for component communication
+
+### 🔌 **Extensibility**
+- **Custom Adapters**: Implement custom data adapters
+- **Custom Actions**: Define custom business logic actions
+- **Custom Validations**: Create custom validation rules
+- **Custom Widgets**: Build custom UI components
+
+## Architecture
+
+ProCode Core follows a modular architecture with clear separation of concerns:
+
+- **Application Start**: Core bootstrapping and dependency injection
+- **Renderer System**: Component rendering with layout, container, and widget renderers
+- **Rule Interpreter**: Business rule processing and UI effect application
+- **Storage Manager**: Flexible storage abstraction layer
+- **Service Layer**: HTTP services and data management
+- **Validation System**: Extensible validation framework
+
+## Examples
+
+### Basic Setup
+
+```tsx
+import React from 'react';
+import Core, { 
+  CoreProps, 
+  IAdapterProvider, 
+  IViewModelHandler 
+} from 'procode-core';
+import 'procode-core/styles';
+
+const App: React.FC = () => {
+  const props: CoreProps = {
+    adapterProvider: myAdapterProvider,
+    viewModelHandler: myViewModelHandler,
+    templateActionProvider: myActionFactory,
+    customWidgetProvider: myWidgetProvider,
+  };
+
+  return <Core {...props} />;
+};
+```
+
+### Custom Adapter Implementation
+
+```tsx
+import { IAdapterProvider, AdapterType, EventService } from 'procode-core';
+
+class MyAdapterProvider implements IAdapterProvider {
+  setUpScreenAdapter(id: string, eventService: EventService): void {
+    // Implement your custom adapter logic
+  }
+}
+```
+
+### Using Interfaces
+
+```tsx
+import { 
+  BaseScreenElement, 
+  WidgetElement, 
+  ScreenSchema,
+  CoreProps 
+} from 'procode-core';
+
+interface MyCustomWidget extends WidgetElement {
+  customProperty: string;
+}
+
+const mySchema: ScreenSchema = {
+  // Define your screen schema
+};
+```
+
+## Requirements
+
+- React 18.2.0+
+- TypeScript 4.9.3+
+- Node.js 16+
+
+## License
+
+MIT
+
+## Contributing
+
+We welcome contributions! Please see our contributing guidelines for more details.
+
+## Support
+
+For support and questions, please visit our documentation or create an issue in the repository.