Skip to content

Commit cce8f26

Browse files
os-zhuangclaude
andcommitted
docs(readme): layered architecture diagram, grouped key features, community
- Replace the ASCII microkernel diagram with a generated layered diagram (ObjectQL / ObjectOS / ObjectUI on the microkernel; everything else a plugin) - Consolidate 14 flat Key Features bullets into 4 themed groups - Add a Community section (star / issues / contributing) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent f1ddc98 commit cce8f26

3 files changed

Lines changed: 23 additions & 42 deletions

File tree

README.md

Lines changed: 13 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -101,21 +101,10 @@ From that single schema, ObjectStack compiles a running backend — the database
101101

102102
## Key Features
103103

104-
- **Built for AI, not retrofitted** — Objects, permissions, flows, APIs, and UI are declarative typed metadata, not hand-written code — small enough for an AI agent to load and safely refactor end-to-end.
105-
- **Agent-ready metadata** — Business objects, actions, and permissions are explicit enough for AI agents to inspect and use.
106-
- **Automatic tool surface** — Metadata can power REST APIs, client SDKs, UI views, and MCP tools without redefining each action by hand.
107-
- **Protocol-first schemas** — All schemas are defined with Zod; TypeScript types are derived via `z.infer<>`.
108-
- **Versioned JSON artifacts** — TypeScript-authored metadata compiles into deployable, self-describing JSON artifacts.
109-
- **Microkernel plugin system** — DI container, EventBus, and lifecycle hooks (init -> start -> destroy).
110-
- **Multi-database support** — In-memory, PostgreSQL, MySQL, SQLite (via the unified SQL driver), and MongoDB. Turso/libSQL is not bundled here — it ships as the separate `@objectstack/driver-turso` package in the cloud repo.
111-
- **7 framework adapters** — Express, Fastify, Hono, NestJS, Next.js, Nuxt, SvelteKit.
112-
- **Client SDK + React hooks**`useQuery`, `useMutation`, `usePagination` out of the box.
113-
- **Built-in authentication**[better-auth](https://www.better-auth.com/) via `plugin-auth`.
114-
- **RBAC / RLS / FLS security** — Role-based, row-level, and field-level access control.
115-
- **Automation engine** — DAG-based flows, triggers, and workflow management.
116-
- **AI service** — Agent, Tool, and Skill protocol built on the Vercel AI SDK.
117-
- **Console UI** — Published ObjectUI console bundle for metadata exploration, schema inspection, API testing, and administration.
118-
- **CLI toolchain**`os init`, `os dev`, `os start`, `os serve`, `os validate`, and more.
104+
- **AI-native, not retrofitted** — Objects, permissions, flows, APIs, and UI are declarative typed metadata, small enough for an agent to load end-to-end. That metadata generates an automatic tool surface — REST APIs, client SDKs, UI views, and an [MCP](packages/mcp) server — so agents inspect and act through the same contracts you defined.
105+
- **Protocol-first runtime** — Every definition starts as a Zod schema (`z.infer<>` types), compiles into versioned, self-describing JSON artifacts, and runs on a microkernel plugin system (DI container, EventBus, `init → start → destroy` lifecycle).
106+
- **Data & framework reach** — In-memory, PostgreSQL, MySQL, SQLite, and MongoDB drivers; 7 framework adapters (Express, Fastify, Hono, NestJS, Next.js, Nuxt, SvelteKit); a client SDK with React hooks (`useQuery` / `useMutation` / `usePagination`).
107+
- **Governance & built-ins** — better-auth, RBAC / RLS / FLS, a DAG-based automation engine, an AI service (Agent / Tool / Skill on the Vercel AI SDK), the ObjectUI Console, and a full CLI (`os init` / `dev` / `compile` / `validate` / …).
119108

120109
## Why AI-native?
121110

@@ -337,33 +326,9 @@ Cloud, package registry, and environment management subcommands (`os publish`, `
337326

338327
ObjectStack uses a **microkernel architecture** where the kernel provides only the essential infrastructure (DI, EventBus, lifecycle), and all capabilities are delivered as plugins. The three protocol layers sit above the kernel:
339328

340-
```
341-
┌─────────────────────────────────────────────────────┐
342-
│ ObjectKernel (Core) │
343-
│ ┌───────────────────────────────────────────────┐ │
344-
│ │ Plugin Lifecycle Manager │ │
345-
│ │ • Dependency Resolution (Topological Sort) │ │
346-
│ │ • Init → Start → Destroy Phases │ │
347-
│ └───────────────────────────────────────────────┘ │
348-
│ ┌───────────────────────────────────────────────┐ │
349-
│ │ Service Registry (DI Container) │ │
350-
│ │ • registerService(name, service) │ │
351-
│ │ • getService<T>(name): T │ │
352-
│ └───────────────────────────────────────────────┘ │
353-
│ ┌───────────────────────────────────────────────┐ │
354-
│ │ Event Bus (Hook System) │ │
355-
│ │ • hook(name, handler) │ │
356-
│ │ • trigger(name, ...args) │ │
357-
│ └───────────────────────────────────────────────┘ │
358-
└─────────────────────────────────────────────────────┘
359-
360-
┌─────────┴─────────┬──────────┬──────────┐
361-
│ │ │ │
362-
┌───▼────┐ ┌───────▼──┐ ┌──▼───┐ ┌───▼────┐
363-
│ObjectQL│ │ Driver │ │ Hono │ │ App │
364-
│ Plugin │ │ Plugin │ │Server│ │ Plugin │
365-
└────────┘ └──────────┘ └──────┘ └────────┘
366-
```
329+
<p align="center">
330+
<img src="docs/screenshots/layers.png" width="900" alt="ObjectStack layered architecture: the ObjectQL data layer, ObjectOS control layer, and ObjectUI view layer sit on a microkernel (plugin lifecycle, service registry / DI, event bus); every capability — drivers, server, auth, security, automation, AI — is a plugin">
331+
</p>
367332

368333
See [ARCHITECTURE.md](./ARCHITECTURE.md) for the complete design documentation including the plugin lifecycle state machine, dependency graph, and design decisions.
369334

@@ -386,6 +351,12 @@ Full documentation: **[https://docs.objectstack.ai](https://docs.objectstack.ai)
386351

387352
Run locally: `pnpm docs:dev`
388353

354+
## Community
355+
356+
-**Star this repo** if ObjectStack is useful — it helps others find it.
357+
- 🐛 Questions, bugs, or feature requests → [open an issue](https://github.com/objectstack-ai/framework/issues).
358+
- 🤝 Want to contribute? See [CONTRIBUTING.md](./CONTRIBUTING.md).
359+
389360
## License
390361

391362
Apache-2.0. Enterprise editions, official cloud services, and marketplace

docs/screenshots/layers.png

220 KB
Loading

docs/screenshots/layers.svg

Lines changed: 10 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)