Skip to content

MontiGem Framework Documentation

Welcome to the official documentation for MontiGem. This documentation is structured into several chapters covering all aspects of the framework.

Table of Contents

  1. Introduction

    • Architecture Overview
    • The TOP Mechanism
  2. Data Modeling (CD4A)

    • Classes, Attributes, Enums
    • Associations & Synchronization
    • Services
    • Multiple Models & Merging
  3. GUI Modeling (GUI DSL)

    • Components & Pages
    • Layouts (Row, Column, Grid, Card)
    • Control Structures (Iterate, Guard)
    • Navigation
    • Generating GUIs (CD2GUI)
  4. Frontend Logic (Java/JSweet)

    • Data Binding
    • Event Handling
    • JSweet Transpilation & Native Interaction (See also: JSweet User Guide)
  5. Runtime Environment (RTE) & Synchronization

    • The Manager
    • Command System
    • Observer Pattern
  6. Styling & Theming

    • SCSS & Identifiers
    • Deep Styling
  7. Backend Customization

    • Startup Logic
    • Custom Commands & Endpoints
  8. The TOP Mechanism

    • Detailed explanation for Backend & Frontend
  9. Project Setup & Build

    • Folder Structure
    • Gradle Tasks
  10. How-To Guides

    • Building a Master-Detail View
  11. Further Reading & External Resources

    • Links to core technologies and advanced topics.
  12. Deployment

    • Docker & Caddy Setup
  13. Testing

    • E2E Testing with Playwright
    • Simulated GUI Tests
  14. Python Client Generator

    • Gradle Setup for Python MontiGem Domain Clients
    • Usage Examples for Python MontiGem Domain Clients