How mirijamarc/generate_crud works
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