A minimal example demonstrating the ObjectStack Protocol with a simple Task management application.
This example serves as a quick-start reference for learning ObjectStack basics. It demonstrates:
- Simple object definition with essential field types
- Basic configuration using
objectstack.config.ts - Minimal setup to get started quickly
For a comprehensive example with advanced features (workflows, validations, multiple views, dashboards), see the CRM Example.
examples/todo/
├── src/
│ ├── domains/
│ │ └── todo/
│ │ └── task.object.ts # Task object definition
│ └── client-test.ts # Client SDK usage example
├── objectstack.config.ts # Application manifest
└── README.md # This file
- Task Object (
todo_task) with essential and advanced field types
- ✅ Text (
subject) - Task title (required field) - ✅ Date (
due_date) - Due date tracking - ✅ Boolean (
is_completed) - Completion status with default value - ✅ Rating (
priority) - 3-star priority rating system - ✅ Color (
category_color) - Color picker with HEX format and preset colors - ✅ Code (
code_snippet) - JavaScript code editor with line numbers - ✅ Rich Text (
notes) - Formatted text with full editor capabilities
- Object capabilities:
apiEnabled,trackHistory - Custom icon (
check-square) - Name field configuration
- Commented action example showing future extensibility
This package is part of the examples workspace. To build and verify:
# Install dependencies (from monorepo root)
pnpm install
# Build the example
pnpm --filter @objectstack/example-todo build
# Run type checking
pnpm --filter @objectstack/example-todo typecheck- Start Here - Simple task object, basic configuration
- Next Step - CRM Example - Advanced features, workflows, validations, UI components
- Then - Official Documentation - Complete protocol reference
- Getting Started Guide
- Object Schema Reference
- Field Types Reference
- CRM Example - Full-featured reference implementation
MIT