The "Constitution" of the Post-SaaS Operating System.
This repository contains the core specifications, schemas, and protocols that power the ObjectStack ecosystem. It defines how data, UI, and system configurations are expressed as code.
ObjectStack is a metadata-driven platform built on three foundational protocols:
- ObjectQL (Data Layer) - Define data structure and queries
- ObjectOS (Control Layer) - Runtime, permissions, and workflows
- ObjectUI (View Layer) - Presentation and user interaction
Learn more: Architecture Overview
-
Getting Started:
- Introduction - Core concepts and architecture
- Quick Start Examples - CRM, Todo, and plugin examples
-
Protocol References:
- Protocol Reference - All 70 protocol specifications
- ObjectQL - Data layer documentation
- ObjectUI - UI layer documentation
- ObjectOS - System layer documentation
-
Development:
- MiniKernel Architecture - Plugin architecture guide
- Writing Plugins - Plugin development guide
- Contributing Guide - How to contribute
# 1. Install dependencies
pnpm install
# 2. Build the Protocol (Generates Schemas & Docs)
pnpm --filter @objectstack/spec build
# 3. Start Documentation Site
pnpm docs:dev
# Visit http://localhost:3000/docs| Package | Description | Status |
|---|---|---|
@objectstack/spec |
Core protocol definitions (Zod schemas, Types, JSON Schemas) | 🟢 Active |
@objectstack/docs |
Documentation site (Fumadocs + Next.js) | 🟢 Active |
examples/crm |
Full-featured CRM example | 🟢 Complete |
examples/todo |
Simple todo app example | 🟢 Active |
We welcome contributions! Please read our Contributing Guide for:
- Development workflow and setup
- Coding standards (Zod-first, camelCase config, snake_case data)
- Testing requirements
- Documentation guidelines
Key Standards:
- All schemas defined using Zod with runtime validation
- Configuration keys:
camelCase(e.g.,maxLength) - Machine names:
snake_case(e.g.,project_task) - Comprehensive JSDoc comments
- 80%+ test coverage
Apache 2.0 © ObjectStack