Skip to content

Commit cc16264

Browse files
Update README to reflect version upgrade to 26.5.2 and enhance package descriptions
1 parent 5608851 commit cc16264

1 file changed

Lines changed: 72 additions & 30 deletions

File tree

README.md

Lines changed: 72 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
[![Maven Central](https://img.shields.io/maven-central/v/tools.dynamia/tools.dynamia.app)](https://search.maven.org/search?q=tools.dynamia)
32
![Java Version Required](https://img.shields.io/badge/java-25-blue)
43
![CalVer](https://img.shields.io/badge/versioning-CalVer%20YY.MM.MINOR-blue)
@@ -8,7 +7,15 @@
87
[![DynamiaTools Documentation](https://img.shields.io/badge/DynamiaTools-Documentation-orange)](https://dynamia.tools/getting-started/)
98

109

11-
<h1 align="center">Dynamia Platform</h1>
10+
11+
12+
<h1 align="center">
13+
<img src="https://raw.githubusercontent.com/dynamiatools/website/main/public/icon.png" alt="Dynamia Logo" width="150"/>
14+
15+
Dynamia Platform
16+
</h1>
17+
18+
1219

1320
> **The Next Generation of DynamiaTools**
1421
@@ -43,7 +50,7 @@ Dynamia Platform represents a major evolution from DynamiaTools, bringing togeth
4350

4451
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.
4552

46-
**Coming Soon**: In upcoming releases, Dynamia Platform will support **modern frontend frameworks** like **React**, **Vue**, and **Angular**, giving you the flexibility to choose your preferred technology stack while maintaining the same automatic generation capabilities. You'll be able to leverage our **TypeScript SDK** and pre-built components to build modern, decoupled SPAs that consume Dynamia's RESTful APIs.
53+
**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`](https://www.npmjs.com/package/@dynamia-tools/vue). You can leverage our **TypeScript SDK** and pre-built components to build modern, decoupled SPAs that consume Dynamia's RESTful APIs.
4754

4855
## ✨ Core Capabilities
4956

@@ -78,19 +85,34 @@ We're actively working on making Dynamia Platform more accessible, flexible, and
7885
- Better search and navigation
7986

8087
#### 📦 **TypeScript SDK**
81-
A complete TypeScript/JavaScript package ecosystem for frontend development:
82-
- **`@dynamia/client`** - Core client library for REST API interaction
83-
- **`@dynamia/types`** - TypeScript type definitions for all API responses
84-
- **`@dynamia/hooks`** - React hooks for common operations
85-
- **`@dynamia/composables`** - Vue composables for reactive integration
88+
A complete TypeScript/JavaScript package ecosystem for frontend development, available on npm:
89+
90+
| Package | Description |
91+
|---|---|
92+
| **[`@dynamia-tools/sdk`](https://www.npmjs.com/package/@dynamia-tools/sdk)** | Core client library for REST API interaction |
93+
| **[`@dynamia-tools/ui-core`](https://www.npmjs.com/package/@dynamia-tools/ui-core)** | Framework-agnostic view/viewer/renderer core |
94+
| **[`@dynamia-tools/vue`](https://www.npmjs.com/package/@dynamia-tools/vue)** | Vue 3 composables and components for reactive integration |
95+
| **[`@dynamia-tools/cli`](https://www.npmjs.com/package/@dynamia-tools/cli)** | CLI tool for scaffolding Dynamia Platform projects |
96+
97+
```bash
98+
# Install the core SDK
99+
npm install @dynamia-tools/sdk
100+
101+
# Install the Vue adapter
102+
npm install @dynamia-tools/vue
103+
104+
# Install the CLI globally
105+
npm install -g @dynamia-tools/cli
106+
```
107+
86108
- Full type safety and IntelliSense support
87109
- Automatic API client generation from backend schema
88110
- WebSocket support for real-time features
89111

90-
#### 🎨 **Vue Template**
91-
Modern frontend template with:
112+
#### 🎨 **Vue Integration** ✅ Available
113+
Modern Vue 3 frontend integration with:
92114
- Vue 3 + TypeScript + Vite
93-
- Pre-configured integration with Dynamia Platform APIs
115+
- Pre-configured integration with Dynamia Platform APIs via `@dynamia-tools/vue`
94116
- Responsive design with Tailwind CSS
95117
- Authentication and authorization out of the box
96118
- CRUD components library
@@ -110,7 +132,7 @@ Seamless integration with popular frameworks:
110132
- Built-in authentication flows
111133

112134
#### **Automation & Developer Experience**
113-
- CLI tool for scaffolding projects and modules
135+
- **[`@dynamia-tools/cli`](https://www.npmjs.com/package/@dynamia-tools/cli)**CLI tool for scaffolding projects and modules
114136
- Code generators for entities, views, and endpoints
115137
- Hot reload for view descriptors
116138
- Development dashboard for monitoring
@@ -147,13 +169,16 @@ Full-featured SaaS support with:
147169
- Payment and subscription handling
148170
- Per-tenant data segregation
149171
- Status monitoring and control
172+
- 📦 **npm:** [`@dynamia-tools/saas-sdk`](https://www.npmjs.com/package/@dynamia-tools/saas-sdk) — TypeScript/JavaScript client SDK for the SaaS REST API
150173

151174
### **Entity File Management**
152175
Attach files to any entity with:
153176
- Local disk storage
154177
- **AWS S3 integration** for cloud storage
178+
- **[Buckie](https://dynamia.tools/buckie/) integration** — the lightweight, filesystem-native file server built by Dynamia (see [GitHub](https://github.com/dynamiatools/buckie) · [npm `@dynamia-tools/buckie`](https://www.npmjs.com/package/@dynamia-tools/buckie))
155179
- Metadata persistence
156180
- Automatic file handling
181+
- 📦 **npm:** [`@dynamia-tools/files-sdk`](https://www.npmjs.com/package/@dynamia-tools/files-sdk) — TypeScript/JavaScript client SDK for the Entity Files REST API
157182

158183
### **Email & SMS**
159184
Professional communication capabilities:
@@ -178,6 +203,7 @@ Comprehensive reporting framework:
178203
- Email delivery
179204
- Chart visualization
180205
- Embeddable reports
206+
- 📦 **npm:** [`@dynamia-tools/reports-sdk`](https://www.npmjs.com/package/@dynamia-tools/reports-sdk) — TypeScript/JavaScript client SDK for the Reports REST API
181207

182208
### **Finance Framework**
183209
Domain-driven financial calculations for:
@@ -230,29 +256,29 @@ Enterprise authentication and authorization:
230256
<dependency>
231257
<groupId>tools.dynamia</groupId>
232258
<artifactId>tools.dynamia.app</artifactId>
233-
<version>26.4.1</version>
259+
<version>26.5.2</version>
234260
</dependency>
235261

236262
<dependency>
237263
<groupId>tools.dynamia</groupId>
238264
<artifactId>tools.dynamia.zk</artifactId>
239-
<version>26.4.1</version>
265+
<version>26.5.2</version>
240266
</dependency>
241267

242268
<dependency>
243269
<groupId>tools.dynamia</groupId>
244270
<artifactId>tools.dynamia.domain.jpa</artifactId>
245-
<version>26.4.1</version>
271+
<version>26.5.2</version>
246272
</dependency>
247273
</dependencies>
248274
```
249275

250276
**Gradle** (`build.gradle`)
251277
```groovy
252278
dependencies {
253-
implementation 'tools.dynamia:tools.dynamia.app:26.4.1'
254-
implementation 'tools.dynamia:tools.dynamia.zk:26.4.1'
255-
implementation 'tools.dynamia:tools.dynamia.domain.jpa:26.4.1'
279+
implementation 'tools.dynamia:tools.dynamia.app:26.5.2'
280+
implementation 'tools.dynamia:tools.dynamia.zk:26.5.2'
281+
implementation 'tools.dynamia:tools.dynamia.domain.jpa:26.5.2'
256282
}
257283
```
258284

@@ -291,67 +317,83 @@ Enterprise authentication and authorization:
291317

292318
### Adding Extensions
293319

294-
To use any of the built-in extensions, simply add their dependencies. **All extensions now share the same version (26.4.1)** thanks to unified CalVer:
320+
To use any of the built-in extensions, simply add their dependencies. **All extensions now share the same version (26.5.2)** thanks to unified CalVer:
295321

296322
```xml
297323
<!-- Multi-tenancy / SaaS -->
298324
<dependency>
299325
<groupId>tools.dynamia.modules</groupId>
300326
<artifactId>tools.dynamia.modules.saas</artifactId>
301-
<version>26.4.1</version>
327+
<version>26.5.2</version>
302328
</dependency>
303329

304330
<!-- Email & SMS -->
305331
<dependency>
306332
<groupId>tools.dynamia.modules</groupId>
307333
<artifactId>tools.dynamia.modules.email</artifactId>
308-
<version>26.4.1</version>
334+
<version>26.5.2</version>
309335
</dependency>
310336

311337
<!-- Entity Files with S3 Support -->
312338
<dependency>
313339
<groupId>tools.dynamia.modules</groupId>
314340
<artifactId>tools.dynamia.modules.entityfiles</artifactId>
315-
<version>26.4.1</version>
341+
<version>26.5.2</version>
316342
</dependency>
317343
<dependency>
318344
<groupId>tools.dynamia.modules</groupId>
319345
<artifactId>tools.dynamia.modules.entityfiles.s3</artifactId>
320-
<version>26.4.1</version>
346+
<version>26.5.2</version>
321347
</dependency>
322348

323349
<!-- Dashboard -->
324350
<dependency>
325351
<groupId>tools.dynamia.modules</groupId>
326352
<artifactId>tools.dynamia.modules.dashboard</artifactId>
327-
<version>26.4.1</version>
353+
<version>26.5.2</version>
328354
</dependency>
329355

330356
<!-- Reporting -->
331357
<dependency>
332358
<groupId>tools.dynamia.reports</groupId>
333359
<artifactId>tools.dynamia.reports.core</artifactId>
334-
<version>26.4.1</version>
360+
<version>26.5.2</version>
335361
</dependency>
336362

337363
<!-- File Importer -->
338364
<dependency>
339365
<groupId>tools.dynamia.modules</groupId>
340366
<artifactId>tools.dynamia.modules.fileimporter</artifactId>
341-
<version>26.4.1</version>
367+
<version>26.5.2</version>
342368
</dependency>
343369

344370
<!-- Security -->
345371
<dependency>
346372
<groupId>tools.dynamia.modules</groupId>
347373
<artifactId>tools.dynamia.modules.security</artifactId>
348-
<version>26.4.1</version>
374+
<version>26.5.2</version>
349375
</dependency>
350376
```
351377

352-
> **💡 Pro Tip**: With CalVer, all Dynamia Platform components use the same version. Just use `26.4.1` for everything!
378+
For extensions that expose a REST API, install their **TypeScript/JavaScript SDK** from npm:
379+
380+
```bash
381+
# Multi-tenancy / SaaS SDK
382+
npm install @dynamia-tools/saas-sdk
383+
384+
# Entity Files SDK (works with local, S3 and Buckie storage)
385+
npm install @dynamia-tools/files-sdk
386+
387+
# Reporting SDK
388+
npm install @dynamia-tools/reports-sdk
389+
390+
# Buckie file server (standalone or as Dynamia storage backend)
391+
npm install @dynamia-tools/buckie
392+
```
393+
394+
> **💡 Pro Tip**: With CalVer, all Dynamia Platform components use the same version. Just use `26.5.2` for everything!
353395
354-
> **Note**: All artifacts are available on [Maven Central](https://search.maven.org/search?q=tools.dynamia)
396+
> **Note**: All artifacts are available on [Maven Central](https://search.maven.org/search?q=tools.dynamia) and npm packages on [npmjs.com](https://www.npmjs.com/search?q=%40dynamia-tools)
355397
356398
## 📚 Documentation
357399

@@ -472,7 +514,7 @@ Java 11+ and ecosystem update:
472514
- 🚀 **Spring Boot 4** - Next-gen Spring ecosystem
473515
- 🎨 **ZK 10+** - Modern web UI capabilities
474516
- 🔄 **Synchronized Releases** - Core, extensions, starters, and themes share the same version
475-
- 🎯 **Simplified Dependencies** - One version to rule them all (e.g., 26.4.1 for February 2026)
517+
- 🎯 **Simplified Dependencies** - One version to rule them all (e.g., 26.5.2 for February 2026)
476518
-**Enhanced Performance** - Optimized for modern JVM and cloud environments
477519
- 🛡️ **Production Hardened** - Battle-tested in enterprise environments
478520

0 commit comments

Comments
 (0)