# harshiempire/my-rules-ast architecture

> Architecture diagram of the GitHub repository harshiempire/my-rules-ast, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/harshiempire/my-rules-ast
- Repository: https://github.com/harshiempire/my-rules-ast

## Overview

##### Main Components

a. Frontend Layer (React.js):
- Rule Management UI (RuleList, RuleCreator)
- Rule Evaluation UI (RuleEvaluator)
- Rule Visualization UI (RuleTree)
- Rule Combination UI (RuleCombiner)

b. Backend Layer (Flask):
- API Routes (rule_routes, evaluation_routes)
- Rule Parser
- Rule Evaluator
- AST Manager
- Database Interface

c. Database Layer:
- A container for "SQLite Database" (or PostgreSQL if using cloud)
- Rules Table

##### Component Relationships

- Frontend → Backend: REST API calls (HTTP)
- Backend → Database: SQL queries via SQLAlchemy
- Internal Backend Flow: Parser → AST → Evaluator

##### Detailed Component Breakdown

a. Rule Processing Pipeline:
**[Rule Input] → [Parser] → [AST Generator] → [AST Optimizer] → [Evaluator]**

b. Data Flow Paths:
- Rule Creation: UI → API → Parser → Database
- Rule Evaluation: UI → API → Evaluator → Result
- Rule Combination: UI → API → AST Merger → Database

##### Technical Stack Indicators

Technology labels:
- Frontend: React.js, Axios, React-D3-Tree
- Backend: Flask, SQLAlchemy, PyParsing
- Database: SQLite/PostgreSQL
- Communication: REST API, JSON

##### Cross-Cutting Concerns

- CORS Management
- Error Handling
- Input Validation
- Security Controls

##### Additional Details

Notes about:
- Scalability points
- Security measures
- Performance optimizations
- Database interactions

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef frontend fill:#3498db,stroke:#2980b9,color:white
    classDef backend fill:#2ecc71,stroke:#27ae60,color:white
    classDef database fill:#f1c40f,stroke:#f39c12,color:black
    classDef security fill:#e74c3c,stroke:#c0392b,color:white
    classDef api fill:#9b59b6,stroke:#8e44ad,color:white

    %% Frontend Layer
    subgraph Frontend
        App["Frontend App"]:::frontend
        click App "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-ui/src/App.js"
        
        subgraph UI_Components
            RuleManagement["Rule Management UI"]:::frontend
            click RuleManagement "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-ui/src/components/RuleList.js"
            
            RuleEval["Rule Evaluation UI"]:::frontend
            click RuleEval "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-ui/src/components/RuleEvaluator.js"
            
            RuleVis["Rule Visualization UI"]:::frontend
            click RuleVis "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-ui/src/components/RuleTree.js"
            
            RuleComb["Rule Combination UI"]:::frontend
            click RuleComb "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-ui/src/components/RuleCombiner.js"
            
            CustomNode["Custom Node Visualization"]:::frontend
            click CustomNode "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-ui/src/components/CustomNode.js"
            
            NavBar["Navigation"]:::frontend
            click NavBar "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-ui/src/components/Navbar.js"
            
            RuleMod["Rule Modification UI"]:::frontend
            click RuleMod "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-ui/src/components/RuleModifier.js"
        end
    end

    %% Backend Layer
    subgraph Backend
        MainApp["Main Application"]:::backend
        click MainApp "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-backend/app.py"
        
        subgraph API_Routes
            RuleRoutes["Rule Routes"]:::api
            click RuleRoutes "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-backend/routes/rule_routes.py"
            
            EvalRoutes["Evaluation Routes"]:::api
            click EvalRoutes "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-backend/routes/evaluation_routes.py"
        end
        
        subgraph Core_Components
            Parser["Rule Parser"]:::backend
            click Parser "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-backend/parser.py"
            
            Evaluator["Rule Evaluator"]:::backend
            click Evaluator "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-backend/evaluator.py"
            
            ASTManager["AST Manager"]:::backend
            click ASTManager "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-backend/node.py"
        end
        
        DBInterface["Database Interface"]:::backend
        click DBInterface "https://github.com/harshiempire/my-rules-ast/blob/main/rule-engine-backend/models.py"
    end

    %% Database Layer
    Database[(SQLite/PostgreSQL)]:::database

    %% Cross-cutting Concerns
    Security["Security Controls"]:::security
    Validation["Input Validation"]:::security
    CORS["CORS Management"]:::security
    ErrorHandler["Error Handling"]:::security

    %% Relationships
    App --> RuleManagement & RuleEval & RuleVis & RuleComb & CustomNode & NavBar & RuleMod
    RuleManagement & RuleEval & RuleVis & RuleComb --> RuleRoutes & EvalRoutes
    RuleRoutes & EvalRoutes --> MainApp
    MainApp --> Parser
    Parser --> ASTManager
    ASTManager --> Evaluator
    MainApp --> DBInterface
    DBInterface --> Database
    
    %% Security Flow
    MainApp --> Security
    MainApp --> Validation
    MainApp --> CORS
    MainApp --> ErrorHandler

    %% Legend
    subgraph Legend
        Frontend_L["Frontend Component"]:::frontend
        Backend_L["Backend Component"]:::backend
        Database_L[(Database)]:::database
        Security_L["Security Component"]:::security
        API_L["API Route"]:::api
    end
```
