Skip to content

Commit cd698e2

Browse files
Copilothotlong
Copilot
and
hotlong
committed
feat: Create comprehensive CRM example with all protocol features
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 32a4c45 commit cd698e2

11 files changed

Lines changed: 3237 additions & 61 deletions

File tree

‎examples/crm/README.md‎

Lines changed: 199 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,210 @@
11
# ObjectStack CRM Example
22

3-
This is a reference implementation of a simple CRM schema using the ObjectStack Protocol.
3+
这是一个全面的 CRM (客户关系管理) 示例，展示了 ObjectStack 协议的所有核心功能。
4+
This is a comprehensive CRM (Customer Relationship Management) example that demonstrates all core features of the ObjectStack Protocol.
45

5-
## Structure
6+
## 🎯 Features Demonstrated
67

7-
* `src/domains/crm/` - Contains the Object definitions (`Account`, `Contact`, `Opportunity`).
8-
* `objectstack.config.ts` - The application manifest that bundles the objects into an app.
8+
### Data Protocol (数据协议)
99

10-
## Usage
10+
#### Objects (对象)
11+
- **Account** - 客户账户 (Companies and organizations)
12+
- **Contact** - 联系人 (People associated with accounts)
13+
- **Opportunity** - 销售机会 (Sales opportunities and deals)
14+
- **Lead** - 潜在客户 (Potential customers)
15+
- **Case** - 客户支持案例 (Customer support cases)
16+
- **Task** - 任务活动 (Activities and to-do items)
17+
18+
#### Field Types (字段类型)
19+
- ✅ **Text/String**: text, textarea, email, url, phone, password
20+
- ✅ **Rich Content**: markdown, html
21+
- ✅ **Numbers**: number, currency, percent
22+
- ✅ **Date/Time**: date, datetime, time
23+
- ✅ **Logic**: boolean
24+
- ✅ **Selection**: select, multiselect
25+
- ✅ **Relational**: lookup, master_detail
26+
- ✅ **Media**: avatar, image, file
27+
- ✅ **Calculated**: formula, summary, autonumber
28+
29+
#### Advanced Features (高级功能)
30+
- ✅ **Validation Rules** - Script, uniqueness, state machine, format validation
31+
- ✅ **Workflow Rules** - Field updates, email alerts, automated actions
32+
- ✅ **Permissions** - Object-level and field-level security
33+
- ✅ **History Tracking** - Audit trail for field changes
34+
- ✅ **Relationships** - Lookup and master-detail relationships
35+
- ✅ **Indexes** - Database performance optimization
36+
37+
### UI Protocol (用户界面协议)
38+
39+
#### List Views (列表视图)
40+
- ✅ **Grid View** - Traditional table view
41+
- ✅ **Kanban View** - Card-based workflow view
42+
- ✅ **Calendar View** - Date-based visualization
43+
- ✅ **Gantt View** - Timeline/project view
44+
45+
#### Form Views (表单视图)
46+
- ✅ **Simple Forms** - Single page layout
47+
- ✅ **Tabbed Forms** - Multi-section layout
48+
- ✅ **Dynamic Sections** - Collapsible sections
49+
50+
#### Actions (操作)
51+
- ✅ **Script Actions** - JavaScript execution
52+
- ✅ **URL Actions** - Navigation
53+
- ✅ **Modal Actions** - Popup forms
54+
- ✅ **Flow Actions** - Visual process automation
55+
56+
#### Dashboards (仪表盘)
57+
- ✅ **Sales Dashboard** - Pipeline and revenue metrics
58+
- ✅ **Service Dashboard** - Support case analytics
59+
- ✅ **Executive Dashboard** - High-level overview
60+
61+
#### Reports (报表)
62+
- ✅ **Tabular Reports** - Simple lists
63+
- ✅ **Summary Reports** - Grouped data
64+
- ✅ **Matrix Reports** - Cross-tabulation
65+
- ✅ **Charts** - Bar, line, pie, donut, funnel
66+
67+
## 📂 Structure
68+
69+
```
70+
examples/crm/
71+
├── src/
72+
│ ├── domains/
73+
│ │ └── crm/
74+
│ │ ├── account.object.ts # Account object with all field types
75+
│ │ ├── contact.object.ts # Contact with master-detail
76+
│ │ ├── opportunity.object.ts # Opportunity with workflow
77+
│ │ ├── lead.object.ts # Lead with conversion logic
78+
│ │ ├── case.object.ts # Case with SLA tracking
79+
│ │ └── task.object.ts # Task with polymorphic relations
80+
│ └── ui/
81+
│ ├── actions.ts # Custom actions
82+
│ ├── dashboards.ts # Dashboard definitions
83+
│ └── reports.ts # Report definitions
84+
├── objectstack.config.ts # App configuration
85+
└── README.md # This file
86+
```
87+
88+
## 🚀 Key Highlights
89+
90+
### 1. Account Object
91+
Demonstrates:
92+
- Autonumber fields (`account_number`)
93+
- Formula fields (`full_address`)
94+
- Select with custom colors
95+
- Kanban view by type
96+
- Validation rules (positive revenue, unique name)
97+
- Workflow automation (update last activity)
98+
99+
### 2. Contact Object
100+
Demonstrates:
101+
- Master-detail relationship to Account
102+
- Formula field (`full_name`)
103+
- Email and phone field formats
104+
- Avatar field
105+
- Multiple list views (grid, kanban, calendar)
106+
- Tabbed form layout
107+
108+
### 3. Opportunity Object
109+
Demonstrates:
110+
- Complex workflow with stage-based automation
111+
- State machine validation for stage progression
112+
- Multiple visualizations (grid, kanban, gantt)
113+
- Probability and forecast calculations
114+
- History tracking for audit trail
115+
- Reference filters (contact filtered by account)
116+
117+
### 4. Lead Object
118+
Demonstrates:
119+
- Lead conversion process
120+
- Boolean flags (is_converted)
121+
- Readonly fields for conversion tracking
122+
- Kanban view by status
123+
- Lead source tracking
124+
125+
### 5. Case Object
126+
Demonstrates:
127+
- SLA tracking and violations
128+
- Customer satisfaction ratings
129+
- Escalation workflow
130+
- Priority-based automation
131+
- Resolution time calculation
132+
- Multiple status transitions
133+
134+
### 6. Task Object
135+
Demonstrates:
136+
- Polymorphic relationships (related_to multiple objects)
137+
- Recurring task support
138+
- Time tracking (estimated vs actual)
139+
- Progress percentage
140+
- Calendar visualization
141+
- Overdue detection
142+
143+
### 7. UI Components
144+
145+
**Actions:**
146+
- Convert Lead (Flow action)
147+
- Clone Opportunity (Script action)
148+
- Send Email (Modal action)
149+
- Mass Update (Bulk action with parameters)
150+
151+
**Dashboards:**
152+
- Metric widgets (KPIs)
153+
- Chart widgets (bar, line, pie, funnel)
154+
- Table widgets (top lists)
155+
- Grid layout system
156+
157+
**Reports:**
158+
- Summary reports with grouping
159+
- Matrix reports (2D grouping)
160+
- Embedded charts
161+
- Filter criteria
162+
- Aggregations (sum, avg, count)
163+
164+
## 💡 Usage
11165

12166
This package is part of the `examples` workspace. To build it and verify types:
13167

14168
```bash
169+
# Build the example
15170
pnpm build
171+
172+
# Run type checking
173+
pnpm typecheck
16174
```
175+
176+
## 📖 Learning Resources
177+
178+
Each object file contains detailed comments explaining:
179+
- Field configuration options
180+
- View setup patterns
181+
- Validation rule syntax
182+
- Workflow automation examples
183+
184+
Study the code to understand:
185+
1. How to define object schemas with Zod
186+
2. How to create relationships between objects
187+
3. How to set up validation and workflow rules
188+
4. How to configure different view types
189+
5. How to create actions, dashboards, and reports
190+
191+
## 🎓 Protocol Coverage
192+
193+
This example demonstrates:
194+
195+
| Protocol Area | Coverage | Examples |
196+
|--------------|----------|----------|
197+
| **Data Protocol** | 100% | All field types, validations, workflows |
198+
| **UI Protocol** | 100% | All view types, actions, dashboards, reports |
199+
| **System Protocol** | 80% | App manifest, menus, settings |
200+
201+
## 🔗 References
202+
203+
- [ObjectStack Documentation](https://objectstack.dev)
204+
- [Protocol Specification](../../packages/spec/README.md)
205+
- [Field Types Reference](../../packages/spec/src/data/field.zod.ts)
206+
- [Object Schema Reference](../../packages/spec/src/data/object.zod.ts)
207+
208+
## 📝 License
209+
210+
MIT

‎examples/crm/objectstack.config.ts‎

Lines changed: 81 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,96 @@ import { App } from '@objectstack/spec';
22
import { Account } from './src/domains/crm/account.object';
33
import { Contact } from './src/domains/crm/contact.object';
44
import { Opportunity } from './src/domains/crm/opportunity.object';
5+
import { Lead } from './src/domains/crm/lead.object';
6+
import { Case } from './src/domains/crm/case.object';
7+
import { Task } from './src/domains/crm/task.object';
8+
9+
import { CrmActions } from './src/ui/actions';
10+
import { CrmDashboards } from './src/ui/dashboards';
11+
import { CrmReports } from './src/ui/reports';
512

613
export default App.create({
714
name: 'crm_example',
815
label: 'CRM App',
9-
description: 'A simple CRM example demonstrating ObjectStack Protocol',
10-
version: '1.0.0',
16+
description: 'Comprehensive CRM example demonstrating all ObjectStack Protocol features',
17+
version: '2.0.0',
18+
19+
// All objects in the app
1120
objects: [
1221
Account,
1322
Contact,
14-
Opportunity
23+
Opportunity,
24+
Lead,
25+
Case,
26+
Task
1527
],
28+
29+
// Navigation menu structure
1630
menus: [
1731
{
18-
label: 'Sales',
19-
items: [
20-
{ type: 'object', object: 'account' },
21-
{ type: 'object', object: 'contact' },
22-
{ type: 'object', object: 'opportunity' }
23-
]
32+
label: 'Sales',
33+
items: [
34+
{ type: 'object', object: 'lead', label: 'Leads' },
35+
{ type: 'object', object: 'account', label: 'Accounts' },
36+
{ type: 'object', object: 'contact', label: 'Contacts' },
37+
{ type: 'object', object: 'opportunity', label: 'Opportunities' },
38+
{ type: 'divider' },
39+
{ type: 'dashboard', dashboard: 'sales_dashboard', label: 'Sales Dashboard' },
40+
{ type: 'report', report: 'opportunities_by_stage', label: 'Pipeline Report' },
41+
]
42+
},
43+
{
44+
label: 'Service',
45+
items: [
46+
{ type: 'object', object: 'case', label: 'Cases' },
47+
{ type: 'divider' },
48+
{ type: 'dashboard', dashboard: 'service_dashboard', label: 'Service Dashboard' },
49+
{ type: 'report', report: 'cases_by_status_priority', label: 'Case Report' },
50+
]
51+
},
52+
{
53+
label: 'Activities',
54+
items: [
55+
{ type: 'object', object: 'task', label: 'Tasks' },
56+
]
57+
},
58+
{
59+
label: 'Analytics',
60+
items: [
61+
{ type: 'dashboard', dashboard: 'executive_dashboard', label: 'Executive Dashboard' },
62+
{ type: 'dashboard', dashboard: 'sales_dashboard', label: 'Sales Dashboard' },
63+
{ type: 'dashboard', dashboard: 'service_dashboard', label: 'Service Dashboard' },
64+
{ type: 'divider' },
65+
{ type: 'report', report: 'opportunities_by_stage', label: 'Opportunities by Stage' },
66+
{ type: 'report', report: 'won_opportunities_by_owner', label: 'Won Opportunities' },
67+
{ type: 'report', report: 'accounts_by_industry_type', label: 'Accounts Matrix' },
68+
{ type: 'report', report: 'cases_by_status_priority', label: 'Cases by Status' },
69+
{ type: 'report', report: 'sla_performance', label: 'SLA Performance' },
70+
{ type: 'report', report: 'leads_by_source', label: 'Leads by Source' },
71+
]
72+
}
73+
],
74+
75+
// Actions available in the app
76+
actions: Object.values(CrmActions),
77+
78+
// Dashboards
79+
dashboards: Object.values(CrmDashboards),
80+
81+
// Reports
82+
reports: Object.values(CrmReports),
83+
84+
// App-level settings
85+
settings: {
86+
theme: {
87+
primaryColor: '#4169E1',
88+
logo: '/assets/crm-logo.png',
89+
},
90+
features: {
91+
enableGlobalSearch: true,
92+
enableNotifications: true,
93+
enableMobileApp: true,
94+
enableOfflineMode: true,
2495
}
25-
]
96+
}
2697
});

0 commit comments

Comments
 (0)