Dynamia Platform

Dynamia Platform

The Next Generation of DynamiaTools

Dynamia Platform is a cutting-edge full-stack Java 25 framework engineered for building robust, scalable enterprise web applications. Powered by Spring Boot 4 and ZK 10, this new generation consolidates the core framework with essential enterprise extensions in a unified, batteries-included platform.

📅 CalVer Versioning

Starting with version 26.2.0, Dynamia Platform adopts Calendar Versioning (CalVer) with the format YY.MM.MINOR. This means:

• All modules share the same version: Core, extensions, starters, themes—everything is released together
• 26.2.0 = First release of February 2026 (Year 26, Month 02, Release 0)
• 26.2.1 = Second release of February 2026 (maintenance)
• 26.3.0 = First release of March 2026
• Unified releases ensure compatibility and simplify dependency management
• No more version mismatches between platform components!

Examples:

• 26.10.0 → October 2026, monthly release
• 26.10.1 → October 2026, maintenance release (fixes and small improvements)
• 26.12.3 → December 2026, fourth release

Where each version is published (details in docs/RELEASING.md):

Version	Maven Central	GitHub Packages	npm
YY.MM.0 (monthly release)	yes	yes	yes
YY.MM.N, N > 0 (maintenance)	no	yes	yes
*-SNAPSHOT (next branch)	no	yes	no

Maven Central limits what an organization can publish per month, so it only receives the monthly YY.MM.0 release. Maintenance versions are published to this repository's GitHub Packages, which requires a GitHub token with read:packages even to download public packages. Unless you need a maintenance fix, use the latest YY.MM.0 from Maven Central.

Add the repository to your pom.xml:

<repositories>
    <repository>
        <id>dynamia-github</id>
        <url>https://maven.pkg.github.com/dynamiatools/framework</url>
    </repository>
</repositories>

And a matching server in ~/.m2/settings.xml, with a personal access token that has read:packages:

<servers>
    <server>
        <id>dynamia-github</id>
        <username>YOUR_GITHUB_USER</username>
        <password>YOUR_GITHUB_TOKEN</password>
    </server>
</servers>

npm packages of every release, maintenance included, are on the public npm registry: no token needed.

🚀 What Makes Dynamia Platform Special

Dynamia Platform represents a major evolution from DynamiaTools, bringing together:

• Unified Repository: Core framework + enterprise extensions in one place
• Production-Ready Extensions: Pre-integrated modules for common enterprise needs
• Zero-Config Philosophy: Sensible defaults with easy customization
• Enterprise-Grade: Built for scalability, multi-tenancy, and security
• Developer Experience: Focus on productivity and code simplicity

🎨 Automatic Frontend Generation

By default, Dynamia Platform automatically generates full-featured web interfaces using ZK Framework, a powerful server-side component framework that eliminates the need to write JavaScript, HTML, or CSS manually. Simply define your entities and view descriptors, and ZK renders responsive, interactive UIs with zero frontend code.

Coming Soon: In upcoming releases, Dynamia Platform will support additional modern frontend frameworks like React and Angular. Vue 3 is already supported via @dynamia-tools/vue. You can leverage our TypeScript SDK and pre-built components to build modern, decoupled SPAs that consume Dynamia's RESTful APIs.

✨ Core Capabilities

• Automatic CRUD Generation: Define entities, get full-featured interfaces instantly
• Automatic REST Endpoints: RESTful APIs generated from your domain models
• Modular Architecture: Build and reuse modules (JARs) across projects
• DRY Principle: Write once, use everywhere approach
• View Descriptors: Declare UIs with YAML instead of verbose code
• Modern Web Stack: HTML5, CSS3, Bootstrap via ZK Framework
• Flexible Patterns: Use MVC or MVVM as per your preference
• Theme Support: Customize look and feel with pluggable themes
• Microfrontend Embedding: Drop a Vue/React/Svelte bundle into any ZK page with <microfrontend>, MVVM binding included
• Seamless Integration: Works with any Java framework or library

🗺️ Roadmap

📋 Short-Term Goals

We're actively working on making Dynamia Platform more accessible, flexible, and developer-friendly. Here's what's coming:

📚 Enhanced Documentation

• Comprehensive guides and tutorials
• Real-world use cases and examples
• API reference improvements
• Video tutorials and screencasts
• Interactive documentation with live code samples

🌐 Website Improvements

• Modernized dynamia.tools website
• Interactive playground for testing features
• Community showcase and success stories
• Regular blog posts with tips and best practices
• Better search and navigation

📦 TypeScript SDK

A complete TypeScript/JavaScript package ecosystem for frontend development, available on npm:

Package	Description
@dynamia-tools/sdk	Core client library for REST API interaction
@dynamia-tools/ui-core	Framework-agnostic view/viewer/renderer core
@dynamia-tools/vue	Vue 3 composables and components for reactive integration
@dynamia-tools/microfrontend-bridge	Typed helpers for bundles embedded via <microfrontend>
@dynamia-tools/cli	CLI tool for scaffolding Dynamia Platform projects
@dynamia-tools/dashboard-sdk · dashboard-vue	Dashboard extension client and Vue 3 components
@dynamia-tools/reports-sdk · reports-vue	Reports extension client and Vue 3 components
· ·

# Install the core SDK
npm install @dynamia-tools/sdk

# Install the Vue adapter
npm install @dynamia-tools/vue

# Install the CLI globally
npm install -g @dynamia-tools/cli

• Full type safety and IntelliSense support
• Automatic API client generation from backend schema
• WebSocket support for real-time features

🎨 Vue Integration ✅ Available

Modern Vue 3 frontend integration with:

• Vue 3 + TypeScript + Vite
• Pre-configured integration with Dynamia Platform APIs via @dynamia-tools/vue
• Responsive design with Tailwind CSS
• Authentication and authorization out of the box
• CRUD components library
• Form validation and data binding
• Real-time updates with WebSocket
• Dashboard and reporting components

🧩 Microfrontend Embedding ✅ Available

Drop external JS bundles (Vue, React, Svelte, plain JS) directly into a ZK page via <microfrontend>, no iframe:

• Three mounting modes: custom element, single-spa-style mountFn/unmountFn, and auto-discovery of a Vite-style dist/ build
• Full ZK MVVM support — @bind/@command work out of the box, including binding whole Java objects as JSON
• Update-in-place on prop changes, shadow-DOM CSS isolation, server↔bundle events, and automatic tenant/locale/auth context injection
• Typed bundle-side helpers via @dynamia-tools/microfrontend-bridge

🔗 Frontend Framework Integration

Seamless integration with popular frameworks:

• React - Components and hooks for React apps
• Vue - Full Vue 3 template and composables
• Angular - Services and components for Angular projects
• Svelte - Stores and components for Svelte
• Next.js / Nuxt - SSR support and optimizations
• Zero-config setup with sensible defaults
• Automatic API discovery and client generation
• Built-in authentication flows

⚡ Automation & Developer Experience

• @dynamia-tools/cli ✅ CLI tool for scaffolding projects and modules
• Code generators for entities, views, and endpoints
• Hot reload for view descriptors
• Development dashboard for monitoring
• Docker Compose templates for quick setup
• GitHub Actions templates for CI/CD
• Automated testing utilities

🔮 Long-Term Vision

• GraphQL Support - Alternative to REST with automatic schema generation
• Microservices Toolkit - Tools for building distributed systems
• Cloud-Native Features - Enhanced Kubernetes support, service mesh integration
• AI-Powered Code Generation - Generate CRUD, forms, and reports from natural language
• Mobile SDK - Native iOS and Android libraries
• Low-Code Builder - Visual editor for building apps without coding

---

🤝 Help Shape the Future

We value community feedback! If you have ideas, suggestions, or want to contribute to any of these initiatives:

• 💬 Join discussions on GitHub Discussions
• 🐛 Report issues or request features on GitHub Issues
• 🌟 Star the project and spread the word!

---

📦 Built-in Enterprise Extensions

Dynamia Platform includes powerful extensions in the /extensions folder:

Multi-Tenancy (SaaS)

Full-featured SaaS support with:

• Account management and isolation
• Payment and subscription handling
• Per-tenant data segregation
• Status monitoring and control
• 📦 npm: @dynamia-tools/saas-sdk — TypeScript/JavaScript client SDK for the SaaS REST API

Entity File Management

Attach files to any entity with:

• Local disk storage
• AWS S3 integration for cloud storage
• Buckie integration — the lightweight, filesystem-native file server built by Dynamia (see GitHub · npm @dynamia-tools/buckie)
• Metadata persistence
• Automatic file handling
• 📦 npm: @dynamia-tools/files-sdk — TypeScript/JavaScript client SDK for the Entity Files REST API

Email & SMS

Professional communication capabilities:

• Email sending via JavaMail
• SMS delivery via AWS
• Template management
• Account configuration
• Delivery logging and tracking

Dashboard

Beautiful, responsive dashboards featuring:

• Custom widget system
• Chart integration
• Responsive layouts
• Real-time data display

Reporting

Comprehensive reporting framework:

• JPQL and native SQL queries
• Datasource management
• Export to CSV, Excel, PDF
• Email delivery
• Chart visualization
• Embeddable reports
• 📦 npm: @dynamia-tools/reports-sdk — TypeScript/JavaScript client SDK for the Reports REST API

Finance Framework

Domain-driven financial calculations for:

• Invoices, credit/debit notes
• Purchase orders and quotes
• Multi-currency support
• Tax, discount, and withholding calculations
• Auditable, deterministic results

File Importer

Streamlined data import workflows:

• Excel/CSV file processing
• Field mapping
• Validation and error handling
• Batch operations

Security

Enterprise authentication and authorization:

• Role-based access control (RBAC)
• User and permission management
• Security profiles
• Integration with Spring Security

🚀 Quick Start

Prerequisites

• Java 25 or higher
• Maven 3.9+ or Gradle 8+
• Your favorite IDE (IntelliJ IDEA, Eclipse, VS Code)

Installation

1. Create a Spring Boot Project

   Visit start.spring.io or click here for a preconfigured template

   Select:

   • Java 25
   • Spring Boot 4.x
   • Spring Web
   • Spring Data JPA
   • H2 Database (or your preferred database)
   • Your preferred language (Java, Kotlin, or Groovy)

2. Add Dynamia Platform Dependencies

   Maven (pom.xml)

   <dependencies>
       <dependency>
           <groupId>tools.dynamia</groupId>
           <artifactId>tools.dynamia.app</artifactId>
           <version>26.10.0</version>
       </dependency>
   
       <dependency>
           <groupId>tools.dynamia</groupId>
           <artifactId>tools.dynamia.zk</artifactId>
           <version>26.10.0</version>
       </dependency>
   
       <dependency>
           <groupId>tools.dynamia</groupId>
           <artifactId>tools.dynamia.domain.jpa</artifactId>
           <version>26.10.0</version>
       </dependency>
   </dependencies>
   

   Gradle (build.gradle)

   dependencies {
       implementation 'tools.dynamia:tools.dynamia.app:26.10.0'
       implementation 'tools.dynamia:tools.dynamia.zk:26.10.0'
       implementation 'tools.dynamia:tools.dynamia.domain.jpa:26.10.0'
   }
   

3. Enable Dynamia Platform

   Add the @EnableDynamiaTools annotation to your main application class:

   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   import tools.dynamia.app.EnableDynamiaTools;
   
   @SpringBootApplication
   @EnableDynamiaTools  // ← This is all you need!
   public class MyApplication {
   
       static void main(String[] args) {
           SpringApplication.run(MyApplication.class, args);
       }
   }
   

4. Run Your Application

   mvn spring-boot:run
   # or
   gradle bootRun
   

5. Access Your Application

Adding Extensions

To use any of the built-in extensions, simply add their dependencies. All extensions now share the same version (26.10.0) thanks to unified CalVer:

<!-- Multi-tenancy / SaaS -->
<dependency>
    <groupId>tools.dynamia.modules</groupId>
    <artifactId>tools.dynamia.modules.saas</artifactId>
    <version>26.10.0</version>
</dependency>

<!-- Email & SMS -->
<dependency>
    <groupId>tools.dynamia.modules</groupId>
    <artifactId>tools.dynamia.modules.email</artifactId>
    <version>26.10.0</version>
</dependency>

<!-- Entity Files with S3 Support -->
<dependency>
    <groupId>tools.dynamia.modules</groupId>
    <artifactId>tools.dynamia.modules.entityfiles</artifactId>
    <version>26.10.0</version>
</dependency>
<dependency>
    <groupId>tools.dynamia.modules</groupId>
    <artifactId>tools.dynamia.modules.entityfiles.s3</artifactId>
    <version>26.10.0</version>
</dependency>

<!-- Dashboard -->
<dependency>
    <groupId>tools.dynamia.modules</groupId>
    <artifactId>tools.dynamia.modules.dashboard</artifactId>
    <version>26.10.0</version>
</dependency>

<!-- Reporting -->
<dependency>
    <groupId>tools.dynamia.modules</groupId>
    <artifactId>tools.dynamia.modules.reports.core</artifactId>
    <version>26.10.0</version>
</dependency>

<!-- File Importer -->
<dependency>
    <groupId>tools.dynamia.modules</groupId>
    <artifactId>tools.dynamia.modules.importer</artifactId>
    <version>26.10.0</version>
</dependency>

<!-- Security -->
<dependency>
    <groupId>tools.dynamia.modules</groupId>
    <artifactId>tools.dynamia.modules.security</artifactId>
    <version>26.10.0</version>
</dependency>

For extensions that expose a REST API, install their TypeScript/JavaScript SDK from npm:

# Multi-tenancy / SaaS SDK
npm install @dynamia-tools/saas-sdk

# Entity Files SDK (works with local, S3 and Buckie storage)
npm install @dynamia-tools/files-sdk

# Reporting SDK
npm install @dynamia-tools/reports-sdk

# Buckie file server (standalone or as Dynamia storage backend)
npm install @dynamia-tools/buckie

💡 Pro Tip: With CalVer, all Dynamia Platform components use the same version. Just use 26.10.0 for everything!

Note: All artifacts are available on Maven Central and npm packages on npmjs.com

📚 Documentation

Comprehensive guides, tutorials, and API documentation are available at:

🌐 https://dynamia.tools

Key Resources

• Getting Started Guide - Your first Dynamia app in 5 minutes
• Core Concepts - Understanding the framework architecture
• View Descriptors - Declarative UI with YAML
• API Reference - Complete API documentation
• Extensions Guide - Working with built-in modules
• Examples - Sample applications

🏗️ Building from Source

Prerequisites

• OpenJDK 25
• Maven 3.9+
• Git

Build Instructions

# Clone the repository
git clone https://github.com/dynamiatools/framework.git
cd framework

# Build all modules
mvn clean install

# Skip tests for faster builds
mvn clean install -DskipTests

# Build only the core platform
cd platform
mvn clean install

# Build only extensions
cd extensions
mvn clean install

Project Structure

framework/
├── platform/           # Core framework modules
│   ├── app/            # Application bootstrap
│   ├── core/           # Core utilities and APIs
│   ├── contract/       # UI contract generator
│   ├── packages/       # TypeScript packages (sdk, ui-core, vue, cli, microfrontend-bridge)
│   ├── starters/       # Spring Boot starters
│   ├── testing/        # Test support (UI contract, UI testing, architecture rules)
│   └── ui/             # ZK UI and shared UI components
├── extensions/         # Enterprise extensions (each with its own TS SDK under packages/)
│   ├── saas/           # Multi-tenancy support
│   ├── entity-files/   # File attachment system
│   ├── email-sms/      # Communication module
│   ├── dashboard/      # Dashboard widgets
│   ├── reports/        # Reporting engine
│   ├── finances/       # Financial calculations
│   ├── file-importer/  # Data import utilities
│   ├── http-functions/ # Declarative, versioned HTTP functions
│   └── security/       # Authentication & authorization
├── themes/             # UI themes
├── examples/           # Sample applications
└── docs/               # Project docs (see RELEASING.md)

📜 Version History & Evolution

Dynamia Platform has evolved over 13+ years of continuous development at Dynamia Soluciones IT, powering 10+ production projects and 40+ modules in real-world enterprise environments.

🎯 Evolution Journey

v1.x - Foundation (2011-2013)

The beginning: Internal utility library focused on:

• Hiding Spring and ZK complexity
• Database abstraction and configuration
• Service layer patterns
• Basic modular architecture

v2.x - Automation (2014-2016)

Revolutionary leap with:

• View Descriptors: YAML-based UI declaration
• Automatic CRUD generation: Zero-code interfaces
• Navigation framework: Modular page system
• Focus on maintainability over code generation

v3.x - Open Source (2017-2019)

Major refactoring and public release:

• Complete code reorganization
• Performance optimizations
• First public open-source release
• Community-driven development begins

v4.x - Modernization (2020-2022)

Java 11+ and ecosystem update:

• Java 11+ support
• Spring Boot integration
• Modern framework compatibility
• Enhanced documentation and demos
• Growing community adoption

v5.x - Platform Era (2023-2025)

The Dynamia Platform Era - Enterprise-ready unified platform:

• ☕ Java 21 - Latest LTS features
• 🚀 Spring Boot 3 - Modern Spring ecosystem
• 🎨 ZK 10 - Advanced UI framework
• 🏢 Unified Repository - Core + Extensions together
• 📦 Production Extensions - Battle-tested enterprise modules
• 🔐 Security First - Built-in authentication & authorization
• ☁️ Cloud Ready - AWS integration, containerization support
• 📊 Enterprise Features - Multi-tenancy, reporting, dashboards

v26.x - CalVer Generation (2026+)

The Modern Era - Simplified versioning and cutting-edge technology:

• 📅 CalVer Versioning (YY.MM.MINOR) - All modules unified under same version (Year.Month.Release)
• ☕ Java 25 - Latest Java innovations and performance
• 🚀 Spring Boot 4 - Next-gen Spring ecosystem
• 🎨 ZK 10+ - Modern web UI capabilities
• 🔄 Synchronized Releases - Core, extensions, starters, and themes share the same version
• 🎯 Simplified Dependencies - One version to rule them all (e.g., 26.10.0 for October 2026)
• ⚡ Enhanced Performance - Optimized for modern JVM and cloud environments
• 🛡️ Production Hardened - Battle-tested in enterprise environments

🏆 Production Proven

• 13+ years of continuous development
• 10+ enterprise applications in production
• 40+ reusable modules built with the framework
• Used by companies across Latin America, USA and Europe
• Powers critical business systems in various industries

This is not a new framework—it's a mature, battle-tested platform that's been serving real businesses for over a decade. Now open-source and ready for the global developer community.

🤝 Contributing

We welcome contributions from the community! Whether it's:

• 🐛 Bug reports and fixes
• ✨ New feature suggestions
• 📚 Documentation improvements
• 💡 Example applications
• 🌐 Translations

Please read our Contributing Guidelines before submitting pull requests.

📄 License

Dynamia Platform is open-source software licensed under the Apache License 2.0.

See LICENSE for details.

☕ Support Dynamia Platform

Dynamia Platform is built with dedication to help developers speed up their projects and make enterprise development more enjoyable. If this platform has been useful to you or your organization, consider supporting its development. Your support helps keep the project alive and evolving with new features and improvements. Every coffee counts! 😊

---

Made with ❤️ by Dynamia Soluciones IT

Website • Documentation • GitHub • Maven Central