# mirijamarc/generate_crud architecture

> Architecture diagram of the GitHub repository mirijamarc/generate_crud, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mirijamarc/generate_crud
- Repository: https://github.com/mirijamarc/generate_crud

## Overview

##### Project type and purpose
- This is a standalone Java-based code-generation tool (a CLI scaffolding utility).
- It reads JSON “mapping” definitions and configuration data, connects (optionally) to a PostgreSQL database, and uses template files to generate Java source code (entities, DTOs, repositories, controllers, views, etc.).

##### File structure
- Top-level folders:
- src
– App.java (entry point)
– base/ (core ORM-like classes: Database, Table, Colonne)
– util/ (Configuration loader, constants, generic utilities)
- mapping/ (JSON model definitions per domain/table)
- data/ (config.json, database.json for connection and settings)
- templates/ (mustache-style templates for each code artifact + subfolders for view inputs)
- lib/ (third-party jars: Jackson for JSON, PostgreSQL JDBC driver)
- bin/ (compiled class output)
- Pattern indications:
- Separation of concerns: configuration, data modeling, templating, code generation
- A pipeline/assembly-line style architecture rather than MVC or microservices

##### Key README insights
- Standard VS Code Java project layout
- Dependencies managed via local lib folder
- Build output in bin/ by default

##### Main components & interactions (to appear
a. Inputs
- Configuration Loader (reads data/config.json, data/database.json via Configuration.java)
- JSON Mapping Loader (uses Jackson jars to parse mapping/*.json into Table/Colonne objects)
b. Processing Engine
- App orchestrator (App.java)
- Database connector (Database.java uses PostgreSQL driver to fetch schema metadata if required)
- Template processor (Util.java loads templates/*.tmp, merges with model objects)
c. Outputs
- Generated Java source files (Entities, DTOs, Repos, Controllers, Views) written to target folders (often under src or a designated output path)
d. External dependencies
- Jackson (jackson-*.jar) for JSON handling
- PostgreSQL JDBC for optional live DB introspection
- File system I/O

##### Important architectural patterns & design principles
- Single Responsibility: each module focuses on one concern (config, model, template, DB, CLI)
- Pipeline architecture: input → transform → output
- Template-driven extensibility: adding new templates or mapping files extends functionality without code changes

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Input Layer
    subgraph "Input Layer"
        ConfigJson["data/config.json"]:::input-blue
        DBJson["data/database.json"]:::input-blue
        MappingJson["mapping/*.json"]:::input-blue
        ControllerTemp["templates/ControllerTemplate.tmp"]:::input-blue
        DTOTemp["templates/DTOTemplate.tmp"]:::input-blue
        EntityTemp["templates/EntityTemplate.tmp"]:::input-blue
        RepoTemp["templates/RepoTemplate.tmp"]:::input-blue
        UtilTemplate["templates/UtilTemplate.tmp"]:::input-blue
        ViewTemp["templates/ViewTemplate.tmp"]:::input-blue
        ViewAdd["templates/view/add/"]:::input-blue
        ViewUpdate["templates/view/update/"]:::input-blue
    end

    %% Processing Layer
    subgraph "Processing Layer"
        Configuration["Configuration Loader"]:::process-green
        Constante["Constants Module"]:::process-green
        JSONLoader["JSON Mapping Loader"]:::process-green
        Orchestrator["Orchestrator (App)"]:::process-green
        UtilProcessor["Template Processor"]:::process-green
        subgraph "Domain Model"
            Table["Table.java"]:::process-green
            Colonne["Colonne.java"]:::process-green
            DBConnector["Database.java"]:::process-green
        end
    end

    %% Output Layer
    subgraph "Output Layer"
        GeneratedCode["Generated Java Code"]:::output-orange
    end

    %% External Dependencies
    subgraph "External Dependencies"
        Jackson1(("jackson-annotations-2.15.2.jar")):::external-gray
        Jackson2(("jackson-core-2.15.2.jar")):::external-gray
        Jackson3(("jackson-databind-2.15.2.jar")):::external-gray
        PGDriver(("postgresql-42.6.0.jar")):::external-gray
    end

    %% Connections
    ConfigJson -->|"load config"| Configuration
    DBJson -->|"load db config"| Configuration
    Configuration -->|"provide config"| Orchestrator

    MappingJson -->|"parse JSON"| JSONLoader
    Jackson1 --> JSONLoader
    Jackson2 --> JSONLoader
    Jackson3 --> JSONLoader
    JSONLoader -->|"build model classes"| Table
    JSONLoader --> Table
    JSONLoader --> Colonne

    Orchestrator -->|"init model"| JSONLoader
    Orchestrator -->|"init DB connector"| DBConnector
    PGDriver --> DBConnector

    ControllerTemp --> UtilProcessor
    DTOTemp --> UtilProcessor
    EntityTemp --> UtilProcessor
    RepoTemp --> UtilProcessor
    UtilTemplate --> UtilProcessor
    ViewTemp --> UtilProcessor
    ViewAdd --> UtilProcessor
    ViewUpdate --> UtilProcessor

    UtilProcessor -->|"merge templates"| GeneratedCode
    Orchestrator -->|"orchestrate generation"| UtilProcessor

    %% Click Events
    click Configuration "https://github.com/mirijamarc/generate_crud/blob/main/src/util/Configuration.java"
    click ConfigJson "https://github.com/mirijamarc/generate_crud/blob/main/data/config.json"
    click DBJson "https://github.com/mirijamarc/generate_crud/blob/main/data/database.json"
    click Constante "https://github.com/mirijamarc/generate_crud/blob/main/src/util/Constante.java"
    click MappingJson "https://github.com/mirijamarc/generate_crud/tree/main/mapping/"
    click Jackson1 "https://github.com/mirijamarc/generate_crud/blob/main/lib/jackson/jackson-annotations-2.15.2.jar"
    click Jackson2 "https://github.com/mirijamarc/generate_crud/blob/main/lib/jackson/jackson-core-2.15.2.jar"
    click Jackson3 "https://github.com/mirijamarc/generate_crud/blob/main/lib/jackson/jackson-databind-2.15.2.jar"
    click Table "https://github.com/mirijamarc/generate_crud/blob/main/src/base/Table.java"
    click Colonne "https://github.com/mirijamarc/generate_crud/blob/main/src/base/Colonne.java"
    click DBConnector "https://github.com/mirijamarc/generate_crud/blob/main/src/base/Database.java"
    click UtilProcessor "https://github.com/mirijamarc/generate_crud/blob/main/src/util/Util.java"
    click ControllerTemp "https://github.com/mirijamarc/generate_crud/blob/main/templates/ControllerTemplate.tmp"
    click DTOTemp "https://github.com/mirijamarc/generate_crud/blob/main/templates/DTOTemplate.tmp"
    click EntityTemp "https://github.com/mirijamarc/generate_crud/blob/main/templates/EntityTemplate.tmp"
    click RepoTemp "https://github.com/mirijamarc/generate_crud/blob/main/templates/RepoTemplate.tmp"
    click UtilTemplate "https://github.com/mirijamarc/generate_crud/blob/main/templates/UtilTemplate.tmp"
    click ViewTemp "https://github.com/mirijamarc/generate_crud/blob/main/templates/ViewTemplate.tmp"
    click ViewAdd "https://github.com/mirijamarc/generate_crud/tree/main/templates/view/add/"
    click ViewUpdate "https://github.com/mirijamarc/generate_crud/tree/main/templates/view/update/"
    click Orchestrator "https://github.com/mirijamarc/generate_crud/blob/main/src/App.java"
    click PGDriver "https://github.com/mirijamarc/generate_crud/blob/main/lib/postgresql-42.6.0.jar"

    %% Styles
    classDef input-blue fill:#E3F2FD,stroke:#90CAF9,color:#0D47A1;
    classDef process-green fill:#E8F5E9,stroke:#66BB6A,color:#1B5E20;
    classDef output-orange fill:#FFF3E0,stroke:#FFA726,color:#E65100;
    classDef external-gray fill:#ECEFF1,stroke:#B0BEC5,color:#37474F;
```
