Skip to content

Commit 2335f27

Browse files
Add API and Hub/Marketplace protocol examples, update main README
Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com>
1 parent 43c8d21 commit 2335f27

4 files changed

Lines changed: 2046 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,24 @@ ObjectStack is a metadata-driven platform built on three foundational protocols:
3434

3535
- **Getting Started:**
3636
- [Introduction](./content/docs/introduction/) - Core concepts and architecture
37-
- [Quick Start Examples](./examples/) - CRM, Todo, and plugin examples
37+
- [📚 Examples Catalog](./examples/README.md) - **Comprehensive examples for all protocols**
38+
- [Quick Start: Todo App](./examples/todo/) - Simplest complete example
39+
- [Quick Start: Basic Examples](./examples/basic/) - Protocol-by-protocol examples
3840

3941
- **Protocol References:**
40-
- [Protocol Reference](./content/docs/references/) - All 70 protocol specifications
42+
- [Protocol Reference](./content/docs/references/) - All 70+ protocol specifications
4143
- [ObjectQL](./content/docs/objectql/) - Data layer documentation
4244
- [ObjectUI](./content/docs/objectui/) - UI layer documentation
4345
- [ObjectOS](./content/docs/objectos/) - System layer documentation
4446

47+
- **Examples by Use Case:**
48+
- [CRM Example](./examples/crm/) - Full-featured enterprise CRM
49+
- [AI Examples](./examples/) - AI Sales, Support, Analyst, Codegen
50+
- [Integration Examples](./examples/basic/integration-connectors-example.ts) - External system connectors
51+
- [System Examples](./examples/basic/system-protocols-example.ts) - Production-grade patterns
52+
- [API Examples](./examples/basic/api-protocols-example.ts) - GraphQL, OData, WebSocket
53+
- [Hub Examples](./examples/basic/hub-marketplace-example.ts) - Marketplace & Plugins
54+
4555
- **Development:**
4656
- [Architecture Guide](./ARCHITECTURE.md) - Complete architecture overview
4757
- [MicroKernel Architecture](./content/docs/developers/micro-kernel.mdx) - Plugin architecture guide

examples/basic/README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,54 @@ Shows advanced system protocols for production applications:
182182
- Security and encryption
183183
- Distributed systems patterns
184184

185+
### Logger & Debugging
186+
**File:** [`logger-example.ts`](./logger-example.ts)
187+
188+
Demonstrates structured logging patterns for production applications.
189+
190+
**Key Concepts:**
191+
- Structured logging with metadata
192+
- Log levels and filtering
193+
- Context propagation
194+
- Performance logging
195+
196+
### API Protocols (Advanced)
197+
**File:** [`api-protocols-example.ts`](./api-protocols-example.ts)
198+
199+
Demonstrates advanced API protocols beyond REST:
200+
- GraphQL API (Schema, Resolvers, Subscriptions)
201+
- OData API (Query capabilities, Metadata)
202+
- WebSocket/Realtime API (Pub/Sub, Live queries)
203+
- Batch Operations (Bulk create/update/delete)
204+
- API Rate Limiting & Versioning
205+
206+
**Key Concepts:**
207+
- Flexible query languages (GraphQL, OData)
208+
- Real-time communication (WebSocket)
209+
- Subscription patterns
210+
- Batch processing for efficiency
211+
- Query complexity and cost analysis
212+
- API security and throttling
213+
214+
### Hub & Marketplace
215+
**File:** [`hub-marketplace-example.ts`](./hub-marketplace-example.ts)
216+
217+
Shows the ObjectStack ecosystem and plugin marketplace:
218+
- Plugin Registry (Publishing and discovery)
219+
- Marketplace (Commercial distribution)
220+
- Licensing (Subscription and perpetual)
221+
- Multi-tenancy (Tenant isolation)
222+
- Spaces (Team workspaces)
223+
- Composer (Visual app builder)
224+
225+
**Key Concepts:**
226+
- Plugin ecosystem management
227+
- SaaS subscription models
228+
- Tenant data isolation
229+
- No-code/low-code platforms
230+
- Commercial software distribution
231+
- Enterprise features (SSO, custom domains)
232+
185233
## 🎯 Usage
186234

187235
These examples are TypeScript files in a proper package that can be:

0 commit comments

Comments
 (0)