Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,29 @@ Stop writing boilerplate controllers.

ObjectOS is built as a modular Monorepo using **NestJS** and follows the **@objectstack/spec** protocol.

### Micro-Kernel Architecture

ObjectOS implements a **micro-kernel plugin architecture** where core functionality is minimal and all features are loaded as plugins:

```
┌─────────────────────────────────────────────────────────┐
│ @objectstack/runtime (Core) │
│ • Plugin Lifecycle Manager (init/start/destroy) │
│ • Service Registry (DI Container) │
│ • Event Bus (Hook System) │
│ • Dependency Resolver (Topological Sort) │
└──────────────┬──────────────────────────────────────────┘
┌───────┴────────┬────────────┬──────────┐
│ │ │ │
┌────▼─────┐ ┌─────▼─────┐ ┌──▼───┐ ┌───▼────┐
│ ObjectQL │ │ Driver │ │Server│ │ Custom │
│ Plugin │ │ Plugin │ │Plugin│ │ Plugin │
└──────────┘ └───────────┘ └──────┘ └────────┘
```

See [@objectstack/runtime](packages/runtime) for details on the plugin system.

### Protocol Compliance

ObjectOS adheres to the [@objectstack/spec](https://github.com/objectstack-ai/spec) protocol, which defines:
Expand All @@ -62,6 +85,7 @@ This ensures interoperability across the ObjectStack ecosystem (ObjectQL, Object

| Package | Role | Description |
| :--- | :--- | :--- |
| **`@objectstack/runtime`** | **The Kernel** | Micro-kernel with plugin lifecycle and service registry. |
| **`@objectos/kernel`** | **The Brain** | The core logic engine. Wraps ObjectQL, manages plugins, and handles the event bus. |
| **`@objectos/server`** | **The Gateway** | NestJS application layer. Handles HTTP/WS traffic, Middlewares, and Guards. |
| **`@objectos/plugin-auth`** | **Auth** | Authentication strategies (Local, OAuth2, Enterprise SSO). |
Expand Down
Loading
Loading