Introduction
A powerful, modular framework for building entity-driven Flutter applications
The Vyuh Entity System is 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.
What is an Entity System?
An Entity System is a software design pattern that treats all business objects (like users, products, orders, or documents) as first-class "entities" with standardized behaviors and lifecycle management.
Instead of building custom code for each business object, an entity system provides:
- Unified CRUD operations - Create, Read, Update, Delete with consistent patterns
- Standardized UI components - Lists, detail views, and forms that work for any entity
- Built-in security - Permission checks applied uniformly across all entities
- Lifecycle management - Common patterns for creation, validation, persistence, and deletion
It is ideal for:
- Enterprise applications with many business objects to manage (CRM, ERP, inventory systems)
- Data-heavy applications requiring consistent CRUD operations
- Multi-tenant SaaS platforms where different customers manage similar entity types
- Compliance-focused systems needing audit trails and permission controls
- Admin panels and dashboards for managing application data
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.
Next Steps
Philosophy
Understand the design principles and architectural decisions behind the entity system
Getting Started
Quick start guide to build your first entity with step-by-step instructions
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!