Cell Framework

License Dart SDK Melos

A comprehensive reactive programming framework for Dart applications requiring high integrity, traceability, and security.

This repository is an umbrella project (monorepo) managed with Melos. It serves as the foundation for the Cell Framework ecosystem, facilitating coordinated development, testing, and versioning across multiple packages.

πŸ“¦ Project Structure

The framework is organized into specialized packages located in the packages/ directory.

Package Version Description
cell 1.0.0-rc.1 Core Package: Fundamental reactive primitives, operators, and progressive disclosure architecture.

πŸš€ Getting Started

Prerequisites

  • Dart SDK: ^3.6.0
  • Melos: Required for monorepo management. Install it globally via pub:

Workspace Setup

  1. Clone the repository:

  2. Bootstrap the workspace: This command installs all dependencies and cross-links the local packages.

πŸ—οΈ Architecture Philosophy

The Cell Framework follows a biological metaphor to describe reactive state management:

  • Cells: Atomic units holding reactive state.
  • Tissues: (Planned) Collections of cells working together.
  • Organs: (Planned) Complex relational structures.

The core cell package provides the foundation, featuring:

  • High Integrity: Built-in validation and security policies.
  • Traceability: Complete causal traces for every state change.
  • Progressive Disclosure: API complexity that scales with your needs.

πŸ› οΈ Development Commands

Use Melos to run commands across the entire monorepo:

Task Command
Analyze melos analyze
Test melos test
Format melos format
Clean melos clean
Check All melos check (Run analysis and tests)

πŸ§ͺ Testing

To run tests for the core package specifically:

cd packages/cell dart test

To run all tests across the monorepo:

melos test

⚠️ Status

Current Version: 1.0.0-rc.1 (Release Candidate)

The core cell package is currently the primary stable entry point. While the API is nearing stability, please refer to the package-specific documentation for detailed implementation guides.

🀝 Contributing

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/amazing-feature).
  3. Commit your changes (git commit -m 'Add amazing feature').
  4. Push to the branch (git push origin feature/amazing-feature).
  5. Open a Pull Request.

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ”— Links

Cell Framework - Building robust, traceable, and secure reactive applications.

Libraries