Skip to content

Commit c4e2df1

Browse files
authored
Merge pull request #129 from objectstack-ai/copilot/update-readme-with-subpackages
2 parents af9edc1 + 040191f commit c4e2df1

File tree

2 files changed

+533
-8
lines changed

2 files changed

+533
-8
lines changed

README.md

Lines changed: 32 additions & 8 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+
35+
| Package | Environment | Description |
36+
| :--- | :--- | :--- |
37+
| **[`@objectql/types`](./packages/foundation/types)** | Universal | **The Contract.** Pure TypeScript interfaces defining the protocol. |
38+
| **[`@objectql/core`](./packages/foundation/core)** | Universal | **The Engine.** The runtime logic, validation, and repository pattern. |
39+
| **[`@objectql/platform-node`](./packages/foundation/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`](./packages/drivers/sql)** | Node.js | SQL database driver (PostgreSQL, MySQL, SQLite, SQL Server) via Knex. |
46+
| **[`@objectql/driver-mongo`](./packages/drivers/mongo)** | Node.js | MongoDB driver with native aggregation pipeline support. |
47+
| **[`@objectql/driver-memory`](./packages/drivers/memory)** | Universal | **In-Memory Driver.** Zero dependencies, perfect for testing and browser apps. |
48+
| **[`@objectql/driver-localstorage`](./packages/drivers/localstorage)** | Browser | **Browser Storage.** Persistent client-side storage using LocalStorage. |
49+
| **[`@objectql/driver-fs`](./packages/drivers/fs)** | Node.js | File system driver with JSON file-based persistent storage. |
50+
| **[`@objectql/driver-excel`](./packages/drivers/excel)** | Node.js | Excel file driver for using `.xlsx` spreadsheets as a data source. |
51+
| **[`@objectql/driver-redis`](./packages/drivers/redis)** | Node.js | Redis driver (example/template implementation for key-value stores). |
52+
| **[`@objectql/sdk`](./packages/drivers/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`](./packages/runtime/server)** | Node.js | HTTP server adapter for Node.js, Express, Next.js with REST and metadata APIs. |
59+
60+
### Tools Layer
61+
3362
| Package | Environment | Description |
3463
| :--- | :--- | :--- |
35-
| **`@objectql/types`** | Universal | **The Contract.** Pure TypeScript interfaces defining the protocol. |
36-
| **`@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/driver-memory`** | Universal | **In-Memory Driver.** Zero dependencies, perfect for testing and browser apps. |
40-
| **`@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. |
64+
| **[`@objectql/cli`](./packages/tools/cli)** | Node.js | Command-line interface with AI-powered generation, dev server, and project management. |
65+
| **[`@objectql/create`](./packages/tools/create)** | Node.js | Project scaffolding tool (`npm create @objectql@latest`). |
66+
| **[`vscode-objectql`](./packages/tools/vscode-objectql)** | VS Code | Official VS Code extension with IntelliSense, validation, and snippets. |
4367

4468
---
4569

0 commit comments

Comments
 (0)