Skip to content

Commit 601286c

Browse files
Copilothuangyiirene
andcommitted
Add README for platform-node and update main README architecture section
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent 0a2d8bd commit 601286c

2 files changed

Lines changed: 529 additions & 4 deletions

File tree

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,40 @@ Traditional ORMs (TypeORM, Prisma) are built for humans writing code in IDEs. Ob
3030

3131
ObjectQL is organized as a Monorepo to ensure modularity and universal compatibility.
3232

33+
### Foundation Layer
34+
3335
| Package | Environment | Description |
3436
| :--- | :--- | :--- |
3537
| **`@objectql/types`** | Universal | **The Contract.** Pure TypeScript interfaces defining the protocol. |
3638
| **`@objectql/core`** | Universal | **The Engine.** The runtime logic, validation, and repository pattern. |
37-
| **`@objectql/driver-sql`** | Node.js | Adapter for SQL databases (Postgres, MySQL, SQLite) via Knex. |
38-
| **`@objectql/driver-mongo`** | Node.js | Adapter for MongoDB. |
39+
| **`@objectql/platform-node`**| Node.js | Node.js platform utilities for file system integration, YAML loading, and plugin management. |
40+
41+
### Driver Layer
42+
43+
| Package | Environment | Description |
44+
| :--- | :--- | :--- |
45+
| **`@objectql/driver-sql`** | Node.js | SQL database driver (PostgreSQL, MySQL, SQLite, SQL Server) via Knex. |
46+
| **`@objectql/driver-mongo`** | Node.js | MongoDB driver with native aggregation pipeline support. |
3947
| **`@objectql/driver-memory`** | Universal | **In-Memory Driver.** Zero dependencies, perfect for testing and browser apps. |
4048
| **`@objectql/driver-localstorage`** | Browser | **Browser Storage.** Persistent client-side storage using LocalStorage. |
41-
| **`@objectql/sdk`** | Universal | **Remote Driver.** Connects to an ObjectQL server via HTTP. |
42-
| **`@objectql/platform-node`**| Node.js | Utilities for loading YAML files from the filesystem. |
49+
| **`@objectql/driver-fs`** | Node.js | File system driver with JSON file-based persistent storage. |
50+
| **`@objectql/driver-excel`** | Node.js | Excel file driver for using `.xlsx` spreadsheets as a data source. |
51+
| **`@objectql/driver-redis`** | Node.js | Redis driver (example/template implementation for key-value stores). |
52+
| **`@objectql/sdk`** | Universal | **Remote HTTP Driver.** Type-safe client for connecting to ObjectQL servers. |
53+
54+
### Runtime Layer
55+
56+
| Package | Environment | Description |
57+
| :--- | :--- | :--- |
58+
| **`@objectql/server`** | Node.js | HTTP server adapter for Node.js, Express, Next.js with REST and metadata APIs. |
59+
60+
### Tools Layer
61+
62+
| Package | Environment | Description |
63+
| :--- | :--- | :--- |
64+
| **`@objectql/cli`** | Node.js | Command-line interface with AI-powered generation, dev server, and project management. |
65+
| **`@objectql/create`** | Node.js | Project scaffolding tool (`npm create @objectql@latest`). |
66+
| **`vscode-objectql`** | VS Code | Official VS Code extension with IntelliSense, validation, and snippets. |
4367

4468
---
4569

0 commit comments

Comments
 (0)