Vyuh Entity System Documentation

Welcome to the comprehensive documentation for the Vyuh Entity System - a powerful, modular framework for building entity-driven Flutter applications. This system provides a complete solution for managing business entities with consistent patterns, rich UI components, and robust security controls.

Overview

The Vyuh Entity System is designed to accelerate Flutter application development by providing:

• Standardized entity management with consistent CRUD operations
• Flexible UI layouts for lists, details, forms, and dashboards
• Built-in security with permission-based access control
• Rich form management with validation and multi-step workflows
• Activity tracking for comprehensive audit trails
• Command palette for efficient navigation
• Extensible architecture supporting custom implementations

Documentation Structure

Core Concepts

1. Philosophy - Understand the design principles and architectural decisions behind the entity system
2. Getting Started - Quick start guide to build your first entity
3. Entity Configuration - Deep dive into the EntityConfiguration class and its components

Entity Management

4. Metadata API - Entity metadata structure and API implementation patterns
5. Entity Lifecycle - Complete guide to entity lifecycle management and relationships
6. Layouts and Views - Comprehensive guide to the layout system
7. Forms and Validation - Form management, validation, and CRUD operations

Advanced Features

8. Permissions - Security implementation with permission guards
9. Command Palette - Global search and keyboard shortcuts
10. Activity Tracking - Audit trails and activity logging
11. Help System - Context-sensitive help integration

Best Practices

12. Best Practices - Recommended patterns and common pitfalls
13. Examples - Real-world examples from production features

Quick Links

• Need to create a new entity? Start with Getting Started
• Implementing custom layouts? See Layouts and Views
• Setting up permissions? Check Permissions
• Looking for examples? Browse Examples

Package Structure

vyuh_entity_system/
├── lib/
│   ├── api/              # Entity API base classes
│   ├── config/           # Configuration classes
│   ├── layouts/          # Built-in layout implementations
│   ├── models/           # Core models
│   ├── permissions/      # Permission system
│   ├── services/         # Core services
│   └── widgets/          # Reusable widgets
└── docs/                 # This documentation

Key Features

🎯 Entity-First Design

Every business object is an entity with standardized behavior, making it easy to add new features without reinventing patterns.

🎨 Flexible UI System

Multiple layout options for every view type - from simple lists to complex dashboards - all configurable without touching the core code.

🔒 Security Built-In

Permission checks at every level ensure your application is secure by default.

📝 Rich Forms

Powerful form system with validation, multi-step workflows, and automatic state management.

🔍 Global Search

Command palette provides instant access to any entity in your system.

📊 Activity Tracking

Every action is logged, providing complete audit trails for compliance and debugging.

Getting Help

• Bug Reports: File issues in the repository
• Community: Join discussions in the project forums
• Examples: Check the Examples section for real-world usage

Contributing

We welcome contributions! Please see our contributing guidelines for more information.

Ready to get started? Head to the Getting Started guide!